Merge pull request #11 from ElMassimo/fix/eager-loading-refactor

Fix error after Mongoid eager loading internals were refactored in 6.0.1

Author: ElMassimo

.travis.yml

@@ -3,30 +3,19 @@ language: ruby
 bundler_args: --without development
 
 rvm:
-  - 2.0.0
-  - 2.1.1
-  - 2.2.2
+  - 2.3.3
 
 gemfile:
   - Gemfile
-  - gemfiles/mongoid4.gemfile
   - gemfiles/mongoid6.gemfile
 
 env:
   global:
     - CI="travis"
     - JRUBY_OPTS="--server -J-Xms512m -J-Xmx1024m"
   matrix:
-    - MONGODB=2.4.14
     - MONGODB=2.6.10
 
-matrix:
-  exclude:
-    - rvm: 2.0.0
-      gemfile: gemfiles/mongoid6.gemfile
-    - rvm: 2.1.1
-      gemfile: gemfiles/mongoid6.gemfile
-
 before_script:
   - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-${MONGODB}.tgz -O /tmp/mongodb.tgz
   - tar -xvf /tmp/mongodb.tgz

Gemfile

@@ -5,7 +5,7 @@ gemspec
 gem 'bundler'
 gem 'rake'
 gem 'pry'
-gem 'mongoid', '~> 5.0.0'
+gem 'mongoid', '6.0.1'
 
 group :test do
   gem 'rspec-given', '~> 3.5'

Gemfile.lock

@@ -7,36 +7,31 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.4)
-      activesupport (= 4.2.4)
-      builder (~> 3.1)
-    activesupport (4.2.4)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    bson (3.2.6)
-    builder (3.2.2)
+    bson (4.2.1)
     codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
+    concurrent-ruby (1.0.4)
     diff-lcs (1.2.5)
     docile (1.1.5)
     given_core (3.7.1)
       sorcerer (>= 0.3.7)
     i18n (0.7.0)
     json (1.8.3)
     method_source (0.8.2)
-    minitest (5.8.1)
-    mongo (2.1.1)
-      bson (~> 3.0)
-    mongoid (5.0.0)
-      activemodel (~> 4.0)
-      mongo (~> 2.1)
-      origin (~> 2.1)
-      tzinfo (>= 0.3.37)
-    origin (2.1.1)
+    minitest (5.10.1)
+    mongo (2.4.1)
+      bson (>= 4.2.1, < 5.0.0)
+    mongoid (6.0.1)
+      activemodel (~> 5.0)
+      mongo (~> 2.3)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -80,7 +75,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   codeclimate-test-reporter
-  mongoid (~> 5.0.0)
+  mongoid (= 6.0.1)
   mongoid_includes!
   pry
   rake

gemfiles/mongoid4.gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: ..
+  specs:
+    mongoid_includes (1.1.3)
+      mongoid (>= 4.0.0, < 7.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    bson (3.2.6)
+    builder (3.2.2)
+    codeclimate-test-reporter (1.0.4)
+      simplecov
+    coderay (1.1.1)
+    connection_pool (2.2.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    given_core (3.8.0)
+      sorcerer (>= 0.3.7)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    moped (2.0.7)
+      bson (~> 3.0)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    optionable (0.2.0)
+    origin (2.3.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-given (3.8.0)
+      given_core (= 3.8.0)
+      rspec (>= 2.14.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sorcerer (1.0.2)
+    thread_safe (0.3.5)
+    tomparse (0.4.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.9.7)
+    yard-tomdoc (0.7.1)
+      tomparse (>= 0.4.0)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  codeclimate-test-reporter
+  mongoid (~> 4.0.2)
+  mongoid_includes!
+  pry
+  rake
+  rspec-given (~> 3.5)
+  yard
+  yard-tomdoc
+
+BUNDLED WITH
+   1.12.5

gemfiles/mongoid6.gemfile

@@ -5,7 +5,7 @@ gemspec path: '..'
 gem 'bundler'
 gem 'rake'
 gem 'pry'
-gem 'mongoid', github: 'mongodb/mongoid', ref: '7c2ff52a0c5292b8e6bf3a9a29bbb19abae3dd5f'
+gem 'mongoid', '~> 6.0.3'
 
 group :test do
   gem 'rspec-given', '~> 3.5'

gemfiles/mongoid6.gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: ..
+  specs:
+    mongoid_includes (1.1.3)
+      mongoid (>= 4.0.0, < 7.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bson (4.2.0)
+    codeclimate-test-reporter (1.0.3)
+      simplecov
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    given_core (3.8.0)
+      sorcerer (>= 0.3.7)
+    i18n (0.7.0)
+    json (2.0.2)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    mongo (2.4.0)
+      bson (~> 4.2.0)
+    mongoid (6.0.3)
+      activemodel (~> 5.0)
+      mongo (~> 2.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-given (3.8.0)
+      given_core (= 3.8.0)
+      rspec (>= 2.14.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sorcerer (1.0.2)
+    thread_safe (0.3.5)
+    tomparse (0.4.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.9.5)
+    yard-tomdoc (0.7.1)
+      tomparse (>= 0.4.0)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  codeclimate-test-reporter
+  mongoid (~> 6.0.3)
+  mongoid_includes!
+  pry
+  rake
+  rspec-given (~> 3.5)
+  yard
+  yard-tomdoc
+
+BUNDLED WITH
+   1.12.5

lib/mongoid/includes/eager_load.rb

@@ -6,13 +6,13 @@ module EagerLoad
 
       # Override: Partitions the inclusions into the different types.
       def eager_load(docs)
-        return false unless eager_loadable?
-
-        nested_inclusions, inclusions = criteria.inclusions.partition(&:nested?)
-        polymorphic_inclusions, inclusions = inclusions.partition(&:polymorphic_belongs_to?)
-        full_preload(docs, inclusions, polymorphic_inclusions, nested_inclusions)
+        if eager_loadable?
+          nested_inclusions, inclusions = criteria.inclusions.partition(&:nested?)
+          polymorphic_inclusions, inclusions = inclusions.partition(&:polymorphic_belongs_to?)
+          full_preload(docs, inclusions, polymorphic_inclusions, nested_inclusions)
+        end
 
-        self.eager_loaded = true
+        docs
       end
 
       # Internal: Performs the normal inclusions first, which allows to perform

spec/mongoid/includes/simple_inclusions_spec.rb

@@ -306,13 +306,6 @@ class D
             end
           end
 
-          it 'does not eager load the first document' do
-            doc = criteria.first
-            expect_query(1) do
-              expect(doc.person).to eq(person)
-            end
-          end
-
           it 'returns the last document' do
             expect(document).to eq(post_two)
           end
@@ -368,13 +361,6 @@ class D
             end
           end
 
-          it 'does not eager load the last document' do
-            doc = criteria.last
-            expect_query(1) do
-              expect(doc.band).to eq(tool)
-            end
-          end
-
           it 'returns the document' do
             expect(document).to eq(address_one)
           end
@@ -400,13 +386,6 @@ class D
             end
           end
 
-          it 'does not eager load the first document' do
-            doc = criteria.first
-            expect_query(1) do
-              expect(doc.band).to eq(depeche)
-            end
-          end
-
           it 'returns the document' do
             expect(document).to eq(address_two)
           end
@@ -500,7 +479,7 @@ class D
           end
 
           before do
-            expect(new_context).to receive(:eager_load_one).with(person).once.and_call_original
+            expect(new_context).to receive(:eager_load).with([person]).once.and_call_original
           end
 
           let!(:from_db) do
@@ -551,7 +530,7 @@ class D
         end
 
         before do
-          expect(context).to receive(:eager_load_one).with(person).once.and_call_original
+          expect(context).to receive(:eager_load).with([person]).once.and_call_original
         end
 
         let!(:from_db) do
@@ -914,7 +893,7 @@ class D
         end
 
         before do
-          expect(context).to receive(:eager_load).with([ game_one, game_two ]).once.and_call_original
+          expect(context).to receive(:preload).twice.and_call_original
         end
 
         let!(:documents) do
@@ -977,7 +956,7 @@ class D
       end
 
       before do
-        expect(context).to receive(:eager_load).with([ person ]).once.and_call_original
+        expect(context).to receive(:preload).twice.and_call_original
       end
 
       let!(:documents) do