mongoid-eager-loading 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-eager-loading (0.2.0)
+    mongoid-eager-loading (0.3.0)
 
 GEM
   remote: http://rubygems.org/
@@ -11,18 +11,18 @@ GEM
       builder (~> 2.1.2)
       i18n (~> 0.4)
     activesupport (3.0.3)
-    bson (1.1.1)
-    bson_ext (1.1.1)
+    bson (1.2.0)
+    bson_ext (1.2.0)
     builder (2.1.2)
     diff-lcs (1.1.2)
-    i18n (0.4.2)
+    i18n (0.5.0)
     mocha (0.9.9)
       rake
-    mongo (1.1.1)
-      bson (>= 1.1.1)
-    mongoid (2.0.0.beta.20)
+    mongo (1.2.0)
+      bson (>= 1.2.0)
+    mongoid (2.0.0.rc.6)
       activemodel (~> 3.0)
-      mongo (~> 1.1)
+      mongo (~> 1.2)
       tzinfo (~> 0.3.22)
       will_paginate (~> 3.0.pre)
     rake (0.8.7)
@@ -36,7 +36,7 @@ GEM
     rspec-mocks (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
-    tzinfo (0.3.23)
+    tzinfo (0.3.24)
     watchr (0.7)
     will_paginate (3.0.pre2)
 
@@ -44,11 +44,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson_ext (~> 1.1.1)
+  bson (= 1.2.0)
+  bson_ext (= 1.2.0)
   bundler (>= 1.0.0)
   mocha
-  mongo (~> 1.1.1)
-  mongoid (= 2.0.0.beta.20)
+  mongo (= 1.2.0)
+  mongoid (= 2.0.0.rc.6)
   mongoid-eager-loading!
   rspec (~> 2.0.0)
   watchr

data/README.md

@@ -5,7 +5,7 @@ mongoid-eager-loading adds the eager loading feature for mongoid.
 
 Originally it is my [pull request][0] for mongoid, but it is not accepted yet, so I created this gem to get the eager loading benefits easily for my projects.
 
-I only test it in mongoid-2.0.0.beta.19, maybe you can try it on other mongoid version, and let me know if it works fine.
+I only test it in mongoid 2.0.0.beta.19 and 2.0.0.beta.20, maybe you can try it on other mongoid version, and let me know if it works fine.
 
 Usage
 -----
@@ -18,7 +18,7 @@ suppose you have a mongoid model Post
 
     class Post
       include Mongoid::Document
-      
+
       referenced_in :user
       references_many :comments
     end
@@ -27,9 +27,9 @@ then you can use the eager loading like
 
     Post.includes(:user)
     Post.includes(:user, :comments)
-    
+
 eager loading can be only used on referenced_in, references_one and references_many associations.
-    
+
 Benchmark
 ---------
 
@@ -37,12 +37,14 @@ I also run a [benchmark][1] on my local computer, the result is as follows
 
     Starting benchmark...
                                                                       user     system      total        real
-    Finding 10 posts with person, without eager loading           0.010000   0.000000   0.010000 (  0.006538)
-    Finding 10 posts with person, with eager loading              0.000000   0.000000   0.000000 (  0.005235)
-    Finding 50 posts with person, without eager loading           0.020000   0.000000   0.020000 (  0.027912)
-    Finding 50 posts with person, with eager loading              0.020000   0.000000   0.020000 (  0.020103)
-    Finding 100 posts with person, without eager loading          0.040000   0.000000   0.040000 (  0.055197)
-    Finding 100 posts with person, with eager loading             0.030000   0.010000   0.040000 (  0.040644)
+    Finding 10 posts with person, without eager loading           0.000000   0.000000   0.000000 (  0.005373)
+    Finding 10 posts with person, with eager loading              0.010000   0.000000   0.010000 (  0.002984)
+    Finding 50 posts with person, without eager loading           0.010000   0.000000   0.010000 (  0.022207)
+    Finding 50 posts with person, with eager loading              0.010000   0.000000   0.010000 (  0.006831)
+    Finding 100 posts with person, without eager loading          0.040000   0.000000   0.040000 (  0.050991)
+    Finding 100 posts with person, with eager loading             0.010000   0.000000   0.010000 (  0.012867)
+    Finding 1000 posts with person, without eager loading         0.390000   0.050000   0.440000 (  0.477983)
+    Finding 1000 posts with person, with eager loading            0.120000   0.010000   0.130000 (  0.128879)
 
 Author
 ------

data/benchmark/benchmark.rb

@@ -5,7 +5,8 @@ require "mongoid"
 require "mongoid-eager-loading"
 
 Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("mongoid_perf_test", :logger => Logger.new($stdout, :info))
+  #config.master = Mongo::Connection.new('localhost', 27018, :logger => Logger.new($stdout)).db("mongoid_perf_test")
+  config.master = Mongo::Connection.new.db("mongoid_perf_test")
 end
 
 Mongoid.master.collection("people").drop
@@ -36,22 +37,28 @@ Benchmark.bm(60) do |bm|
   bm.report("Finding 10 posts with person, without eager loading") do
     Post.limit(10).each { |p| p.person.name }
   end
-
   bm.report("Finding 10 posts with person, with eager loading") do
     Post.limit(10).includes(:person).each { |p| p.person.name }
   end
+
   bm.report("Finding 50 posts with person, without eager loading") do
     Post.limit(50).each { |p| p.person.name }
   end
-
   bm.report("Finding 50 posts with person, with eager loading") do
     Post.limit(50).includes(:person).each { |p| p.person.name }
   end
+
   bm.report("Finding 100 posts with person, without eager loading") do
     Post.limit(100).each { |p| p.person.name }
   end
-
   bm.report("Finding 100 posts with person, with eager loading") do
     Post.limit(100).includes(:person).each { |p| p.person.name }
   end
+
+  bm.report("Finding 1000 posts with person, without eager loading") do
+    Post.limit(1000).each { |p| p.person.name }
+  end
+  bm.report("Finding 1000 posts with person, with eager loading") do
+    Post.limit(1000).includes(:person).each { |p| p.person.name }
+  end
 end

data/lib/mongoid-eager-loading.rb

@@ -1,8 +1,3 @@
 require 'mongoid-eager-loading/mongoid/criterion/eager_loading'
 require 'mongoid-eager-loading/mongoid/criteria'
-require 'mongoid-eager-loading/mongoid/finders'
-
-module Mongoid
-  module EagerLoading
-  end
-end
+require 'mongoid-eager-loading/mongoid/finders'

data/lib/mongoid-eager-loading/mongoid/criterion/eager_loading.rb

@@ -35,75 +35,75 @@ module Mongoid
         end
 
         def setup_associations(documents, reflection)
-          if reflection.association == Mongoid::Associations::ReferencesOne
+          case reflection.macro
+          when :references_one
             setup_associations_with_ids(documents, reflection, true)
-          elsif reflection.association == Mongoid::Associations::ReferencesMany
+          when :references_many
             setup_associations_with_ids(documents, reflection, false)
-          elsif reflection.association == Mongoid::Associations::ReferencesManyAsArray
+          when :references_and_referenced_in_many
             setup_associations_with_foreign_keys(documents, reflection, false)
-          elsif reflection.association == Mongoid::Associations::ReferencedIn
+          when :referenced_in
             setup_associations_with_foreign_keys(documents, reflection, true)
           end
         end
 
         def setup_associations_with_ids(documents, reflection, one=true)
-          ids = []
-          documents.each do |document|
-            add_id_document(document.id, document)
-            ids << document.id if document.id
-          end
+          ids = association_ids(documents, reflection)
 
-          association_class = reflection.name.singularize.camelize.constantize
           ignore_includes
-          eager_associations = association_class.where(reflection.foreign_key.to_sym.in => ids.uniq).to_a
+          eager_associations = reflection.klass.where(reflection.foreign_key.to_sym.in => ids.uniq).to_a
           eager_associations.each do |eager_association|
             add_id_association(eager_association.send(reflection.foreign_key), eager_association)
           end
 
-          id_documents_map.each do |id, documents|
-            documents.each do |document|
-              document.instance_variable_set("@#{reflection.name}", one ? id_associations_map[id].first : id_associations_map[id])
-            end
-          end
+          assign_associations(documents, reflection)
         end
 
         def setup_associations_with_foreign_keys(documents, reflection, one)
-          ids = []
-          foreign_key_name = reflection.foreign_key
-          documents.each do |document|
-            foreign_key_value = document.send(foreign_key_name)
-            if one
-              add_id_document(foreign_key_value, document)
-              ids << foreign_key_value if foreign_key_value
-            elsif foreign_key_value
-              foreign_key_value.each do |fkv|
-                add_id_document(fkv, document)
-                ids << fkv if fkv
-              end
-            end
-          end
+          ids = association_ids(documents, reflection)
 
-          association_class = reflection.name.singularize.camelize.constantize
           ignore_includes
-          eager_associations = association_class.find(ids.uniq).to_a
+          eager_associations = reflection.klass.find(ids.uniq).to_a
           eager_associations.each do |eager_association|
             add_id_association(eager_association.id, eager_association)
           end
 
+          assign_associations(documents, reflection)
+        end
+
+        def association_ids(documents, reflection)
+          ids = []
+          key_name = reflection.key
+          documents.each do |document|
+            key_value = document.send(key_name)
+            to_array(key_value).each do |v|
+              add_id_document(v, document)
+              ids << v
+            end
+          end
+          ids
+        end
+
+        def assign_associations(documents, reflection)
           id_documents_map.each do |id, documents|
             documents.each do |document|
-              foreign_key_value = document.send(foreign_key_name)
+              key_value = document.send(reflection.key)
               associations = \
-                if one
-                  id_associations_map[foreign_key_value].first
+                if key_value.is_a?(Array)
+                  key_value.collect { |v| id_associations_map[v] }
                 else
-                  foreign_key_value.collect { |fkv| id_associations_map[fkv] }.flatten.uniq
+                  id_associations_map[key_value] ? id_associations_map[key_value].first : nil
                 end
               document.instance_variable_set("@#{reflection.name}", associations)
             end
           end
         end
 
+        def to_array(value)
+          array = value.is_a?(Array) ? value : [value]
+          array.compact
+        end
+
         def id_documents_map
           @id_documents_map ||= {}
         end

data/lib/mongoid-eager-loading/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module EagerLoading
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/mongoid-eager-loading.gemspec

@@ -15,12 +15,13 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "mongoid-eager-loading"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "mongoid", "2.0.0.beta.20"
+  s.add_development_dependency "mongo", "1.2.0"
+  s.add_development_dependency "bson", "1.2.0"
+  s.add_development_dependency "bson_ext", "1.2.0"
+  s.add_development_dependency "mongoid", "2.0.0.rc.6"
   s.add_development_dependency "rspec", "~> 2.0.0"
   s.add_development_dependency "mocha"
   s.add_development_dependency "watchr"
-  s.add_development_dependency "bson_ext", "~> 1.1.1"
-  s.add_development_dependency "mongo", "~> 1.1.1"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/spec/models/account.rb

@@ -1,10 +1,16 @@
 class Account
   include Mongoid::Document
+  field :number, :type => String
+  field :balance, :type => String
+  field :nickname, :type => String
+  field :name, :type => String
+
+  embeds_many :memberships
   referenced_in :creator, :class_name => "User", :foreign_key => :creator_id
   referenced_in :person
-  field :number
-  field :balance
-  field :nickname
-  
-  attr_accessible :nickname
+
+  attr_accessible :nickname, :name
+
+  validates_presence_of :name
+  validates_length_of :name, :maximum => 10, :on => :create
 end

data/spec/models/address.rb

@@ -15,7 +15,7 @@ class Address
   key :street
   embeds_many :locations
 
-  embedded_in :addressable, :inverse_of => :addresses do
+  embedded_in :addressable, :polymorphic => true do
     def extension
       "Testing"
     end
@@ -24,6 +24,8 @@ class Address
     end
   end
 
+  referenced_in :account
+
   named_scope :rodeo, where(:street => "Rodeo Dr") do
     def mansion?
       all? { |address| address.street == "Rodeo Dr" }
@@ -31,11 +33,16 @@ class Address
   end
 
   validates_presence_of :street, :on => :update
+  validates_format_of :street, :with => /\D/, :allow_nil => true
 
   def set_parent=(set = false)
     self.parent_title = addressable.title if set
   end
 
+  def <=>(other)
+    street <=> other.street
+  end
+
   class << self
     def california
       where(:state => "CA")

data/spec/models/address_component.rb

@@ -0,0 +1,5 @@
+class AddressComponent
+  include Mongoid::Document
+  field :street, :type => String
+  embedded_in :person
+end

data/spec/models/agent.rb

@@ -2,7 +2,6 @@ class Agent
   include Mongoid::Document
   field :title
   field :number
-  embeds_many :names
-  references_many :posts, :foreign_key => :poster_id
-  accepts_nested_attributes_for :posts, :allow_destroy => true
+  embeds_many :names, :as => :namable
+  referenced_in :game
 end

data/spec/models/animal.rb

@@ -1,15 +1,18 @@
 class Animal
   include Mongoid::Document
   field :name
-  field :tags, :type => Array  
+  field :tags, :type => Array
   key :name
-  embedded_in :person, :inverse_of => :pet
-  
+
+  embedded_in :person
+
+  accepts_nested_attributes_for :person
+
   def tag_list
     tags.join(", ")
   end
-  
+
   def tag_list=(_tag_list)
     self.tags = _tag_list.split(",").map(&:strip)
-  end  
+  end
 end

data/spec/models/answer.rb

@@ -1,4 +1,4 @@
 class Answer
   include Mongoid::Document
-  embedded_in :question, :inverse_of => :answers
+  embedded_in :question
 end

data/spec/models/bar.rb

@@ -0,0 +1,5 @@
+class Bar
+  include Mongoid::Document
+  field :name, :type => String
+  references_one :rating, :as => :ratable
+end

data/spec/models/book.rb

@@ -0,0 +1,5 @@
+class Book
+  include Mongoid::Document
+  field :title, :type => String
+  references_one :rating, :as => :ratable, :dependent => :nullify
+end

data/spec/models/business.rb

@@ -0,0 +1,7 @@
+class Business
+  include Mongoid::Document
+
+  set_database :secondary
+
+  field :name
+end

data/spec/models/callbacks.rb

@@ -20,13 +20,13 @@ end
 class Song
   include Mongoid::Document
   field :title
-  embedded_in :artist, :inverse_of => :songs
+  embedded_in :artist
 end
 
 class Label
   include Mongoid::Document
   field :name
-  embedded_in :artist, :inverse_of => :labels
+  embedded_in :artist
   before_validation :cleanup
 
   private

data/spec/models/category.rb

@@ -5,9 +5,9 @@ end
 
 class Category
   include Mongoid::Document
-  embedded_in :root_category, :inverse_of => :categories
-  embedded_in :category, :inverse_of => :categories
+  embedded_in :root_category
+  embedded_in :category
   embeds_many :categories
 
   field :name
-end
+end