mongoid 7.0.0 → 7.4.0

data/spec/mongoid/association/polymorphic_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "Polymorphic Associations" do
@@ -98,4 +100,63 @@ describe "Polymorphic Associations" do
       end
     end
   end
+
+  context 'when the relation is touchable' do
+
+    context 'when the relation is embedded' do
+
+      let(:define_classes) do
+
+        class FirstOwner
+          include Mongoid::Document
+
+          embeds_one :owned, class_name: 'Owned', as: :embedded_relation_polymorphic_touch_owner
+        end
+
+        class SecondOwner
+          include Mongoid::Document
+
+          embeds_one :owned, class_name: 'Owned', as: :embedded_relation_polymorphic_touch_owner
+        end
+
+        class Owned
+          include Mongoid::Document
+
+          embedded_in :embedded_relation_polymorphic_touch_owner, polymorphic: true, touch: true
+        end
+      end
+
+      it 'successfully defines the touch method' do
+       expect { define_classes }.not_to raise_error
+      end
+    end
+
+    context 'when the relation is not embedded' do
+
+      let(:define_classes) do
+
+        class FirstOwner
+          include Mongoid::Document
+
+          has_one :owned, class_name: 'Owned', as: :belongs_relation_polymorphic_touch_owner
+        end
+
+        class SecondOwner
+          include Mongoid::Document
+
+          has_one :owned, class_name: 'Owned', as: :belongs_relation_polymorphic_touch_owner
+        end
+
+        class Owned
+          include Mongoid::Document
+
+          belongs_to :belongs_relation_polymorphic_touch_owner, polymorphic: true, touch: true
+        end
+      end
+
+      it 'successfully defines the touch method' do
+       expect { define_classes }.not_to raise_error
+      end
+    end
+  end
 end

data/spec/mongoid/association/referenced/belongs_to/binding_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Association::Referenced::BelongsTo::Binding do

data/spec/mongoid/association/referenced/belongs_to/buildable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Association::Referenced::BelongsTo::Buildable do
@@ -12,8 +14,12 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
       association.build(base, object)
     end
 
+    let(:options) do
+      {}
+    end
+
     let(:association) do
-      Post.relations['person']
+      Mongoid::Association::Referenced::BelongsTo.new(Post, :person, options)
     end
 
     context "when provided an id" do
@@ -21,7 +27,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
       context "when the object is an object id" do
 
         let!(:person) do
-          Person.create(_id: object)
+          Person.create!(_id: object, username: 'Bob')
         end
 
         let(:object) do
@@ -29,7 +35,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
         end
 
         before do
-          expect(Person).to receive(:where).with(association.primary_key => object).and_call_original
+          expect_any_instance_of(Mongoid::Criteria).to receive(:where).with(association.primary_key => object).and_call_original
         end
 
         it "sets the document" do
@@ -37,6 +43,41 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
         end
       end
 
+      context "when scope is specified" do
+
+        let!(:person) do
+          Person.create(_id: object, username: 'Bob')
+        end
+
+        let(:object) do
+          BSON::ObjectId.new
+        end
+
+        let(:options) do
+          {
+            scope: -> { where(username: 'Bob') }
+          }
+        end
+
+        context "when document satisfies scope" do
+
+          it "sets the document" do
+            expect(document).to eq(person)
+          end
+        end
+
+        context "when document does not satisfy scope" do
+
+          let!(:person) do
+            Person.create(_id: object, username: 'Bruce')
+          end
+
+          it "returns nil" do
+            expect(document).to eq(nil)
+          end
+        end
+      end
+
       context 'when the id is nil' do
 
         let(:object) do
@@ -55,7 +96,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
       context "when the id does not correspond to a document in the database" do
 
         let!(:person) do
-          Person.create
+          Person.create!
         end
 
         let(:object) do
@@ -63,7 +104,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
         end
 
         before do
-          expect(Person).to receive(:where).with(association.primary_key => object).and_call_original
+          expect_any_instance_of(Mongoid::Criteria).to receive(:where).with(association.primary_key => object).and_call_original
         end
 
         it 'returns nil' do
@@ -74,7 +115,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
       context "when the object is an integer" do
 
         let!(:person) do
-          Person.create(_id: object)
+          Person.create!(_id: object)
         end
 
         let(:object) do
@@ -82,7 +123,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
         end
 
         before do
-          expect(Person).to receive(:where).with(association.primary_key => object).and_call_original
+          expect_any_instance_of(Mongoid::Criteria).to receive(:where).with(association.primary_key => object).and_call_original
         end
 
         it "sets the document" do
@@ -94,7 +135,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
     context "when provided a object" do
 
       let!(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:object) do
@@ -102,7 +143,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
       end
 
       before do
-        expect(Person).not_to receive(:where)
+        expect_any_instance_of(Mongoid::Criteria).not_to receive(:where)
       end
 
       it "returns the object" do
@@ -113,7 +154,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
     context "when the document is persisted" do
 
       let!(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:game) do
@@ -128,16 +169,16 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
     context 'setting an associated document to nil' do
 
       let(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:game) do
-        Game.create(person: person)
+        Game.create!(person: person)
       end
 
       before do
         game.person = nil
-        game.save
+        game.save!
       end
 
       it 'sets the person_id to nil' do
@@ -153,11 +194,11 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
   describe '#substitute' do
 
     let(:person) do
-      Person.create
+      Person.create!
     end
 
     let(:game) do
-      Game.create(person: person)
+      Game.create!(person: person)
     end
 
     context 'setting an associated document to nil' do
@@ -178,7 +219,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Buildable do
     context 'setting an associated document to other doc' do
 
       let(:other_person) do
-        Person.create
+        Person.create!
       end
 
       before do

data/spec/mongoid/association/referenced/belongs_to/eager_spec.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require "spec_helper"
+require_relative '../has_many_models'
+require_relative '../has_one_models'
 
 describe Mongoid::Association::Referenced::BelongsTo::Eager do
 
@@ -55,7 +59,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       Post.create!(person: person)
     end
 
-    it "sets the relation into the parent" do
+    it "sets the association into the parent" do
       docs.each do |doc|
         expect(doc).to receive(:set_relation).with(:person, :foo)
       end
@@ -73,7 +77,10 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       3.times { |i| Account.create!(person: person, name: "savings#{i}") }
     end
 
-    context "when including the belongs_to relation" do
+    context "when including the belongs_to association" do
+      # Query count assertions require that all queries are sent using the
+      # same connection object.
+      require_no_multi_shard
 
       it "queries twice" do
 
@@ -85,7 +92,10 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       end
     end
 
-    context "when the relation is not polymorphic" do
+    context "when the association is not polymorphic" do
+      # Query count assertions require that all queries are sent using the
+      # same connection object.
+      require_no_multi_shard
 
       let(:eager) do
         Post.includes(:person).last
@@ -94,7 +104,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       context "when the eager load has returned documents" do
 
         let!(:post) do
-          person.posts.create(title: "testing")
+          person.posts.create!(title: "testing")
         end
 
         before { eager }
@@ -104,13 +114,13 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
         end
 
         it "does not query when touching the association" do
-          expect_query(0) do
+          expect_no_queries do
             expect(eager.person).to eq(person)
           end
         end
 
         it "does not query when updating the association" do
-          expect_query(0) do
+          expect_no_queries do
             eager.person.username = "arthurnn"
           end
         end
@@ -119,7 +129,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       context "when the eager load has not returned documents" do
 
         let!(:post) do
-          Post.create(title: "testing")
+          Post.create!(title: "testing")
         end
 
         before { eager }
@@ -128,26 +138,244 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
           expect(eager.ivar(:person)).to be nil
         end
 
-        it "has a nil relation" do
+        it "has a nil association" do
           expect(eager.person).to be nil
         end
       end
     end
 
-    context "when the relation is polymorphic" do
+    context "when the association is polymorphic" do
+
+      context "without namespaces" do
+
+        let!(:stand_alone_rating) do
+          Rating.create!(value: 7)
+        end
+
+        let!(:bar) do
+          Bar.create!(name: "FooBar")
+        end
+
+        let(:bar_rating) do
+          bar.create_rating(value: 5)
+        end
+
+        let!(:movie) do
+          Movie.create!(name: "Bladerunner")
+        end
+
+        let(:movie_rating) do
+          movie.ratings.create!(value: 10)
+        end
+
+        let(:eager) do
+          Rating.includes(:ratable).entries
+        end
+
+        context "when the eager load has returned documents" do
+
+          before do
+            bar_rating
+            movie_rating
+            eager
+          end
+
+          it "puts the documents in the parent document" do
+            expect(eager.map { |e| e.ivar(:ratable) }).to eq([nil, bar, movie])
+          end
+
+          it "does not query when touching the association" do
+            expect_no_queries do
+              expect(eager.map(&:ratable)).to eq([nil, bar, movie])
+            end
+          end
+
+          it "does not query when updating the association" do
+            expect_no_queries do
+              eager.last.ratable.name = "Easy rider"
+            end
+          end
+        end
+
+        context "when the eager load has not returned documents" do
+
+          before { eager }
+
+          it "does not set anything on the parent" do
+            expect(eager.map { |e| e.ivar(:ratable) }).to all(be nil)
+          end
 
-      let!(:movie) do
-        Movie.create(name: "Bladerunner")
+          it "has a nil association" do
+            expect(eager.map(&:ratable)).to all(be nil)
+          end
+        end
       end
 
-      let!(:rating) do
-        movie.ratings.create(value: 10)
+      context "with namespaces" do
+
+        let!(:stand_alone_review) do
+          Publication::Review.create!(summary: "awful")
+        end
+
+        let!(:encyclopedia) do
+          Publication::Encyclopedia.create!(title: "Encyclopedia Britannica")
+        end
+
+        let(:encyclopedia_review) do
+          encyclopedia.reviews.create!(summary: "inspiring")
+        end
+
+        let!(:pull_request) do
+          Coding::PullRequest.create!(title: "Add eager loading for polymorphic belongs_to associations")
+        end
+
+        let(:pull_request_review) do
+          pull_request.reviews.create!(summary: "Looks good to me")
+        end
+
+        let(:eager) do
+          Publication::Review.includes(:reviewable).entries
+        end
+
+        context "when the eager load has returned documents" do
+
+          before do
+            encyclopedia_review
+            pull_request_review
+            eager
+          end
+
+          it "puts the documents in the parent document" do
+            expect(eager.map { |e| e.ivar(:reviewable) }).to eq([nil, encyclopedia, pull_request])
+          end
+
+          it "does not query when touching the association" do
+            expect_no_queries do
+              expect(eager.map(&:reviewable)).to eq([nil, encyclopedia, pull_request])
+            end
+          end
+
+          it "does not query when updating the association" do
+            expect_no_queries do
+              eager.last.reviewable.title = "Load stuff eagerly"
+            end
+          end
+        end
+
+        context "when the eager load has not returned documents" do
+
+          before { eager }
+
+          it "does not set anything on the parent" do
+            expect(eager.map { |e| e.ivar(:reviewable) }).to all(be nil)
+          end
+
+          it "has a nil association" do
+            expect(eager.map(&:reviewable)).to all(be nil)
+          end
+        end
       end
 
-      it "raises an error" do
-        expect {
-          Rating.includes(:ratable).last
-        }.to raise_error(Mongoid::Errors::EagerLoad)
+      context 'when eager loading multiple associations' do
+        let(:reviewable) do
+          Publication::Encyclopedia.create!(title: "Encyclopedia Britannica")
+        end
+
+        let!(:reviewable_review) do
+          Publication::Review.create!(summary: "awful",
+            reviewable: reviewable)
+        end
+
+        let(:reviewer) do
+          Dog.create!
+        end
+
+        let!(:reviewer_review) do
+          Publication::Review.create!(summary: "okay",
+            reviewer: reviewer)
+        end
+
+        let(:template) do
+          Template.create!
+        end
+
+        let!(:template_review) do
+          Publication::Review.create!(summary: "Looks good to me",
+            template: template)
+        end
+
+        let(:eager) do
+          Publication::Review.includes(:reviewable, :reviewer, :template).entries
+        end
+
+        it 'loads all associations eagerly' do
+          loaded = expect_query(4) do
+            eager
+          end
+
+          expect_no_queries do
+            eager.map(&:reviewable).compact.should == [reviewable]
+          end
+
+          expect_no_queries do
+            eager.map(&:reviewer).compact.should == [reviewer]
+          end
+
+          expect_no_queries do
+            eager.map(&:template).compact.should == [template]
+          end
+        end
+      end
+
+      context 'when eager loading an association that has type but not value set' do
+
+        let!(:reviewer_review) do
+          Publication::Review.create!(summary: "okay",
+            reviewer_type: 'Dog')
+        end
+
+        let(:eager) do
+          Publication::Review.includes(:reviewable, :reviewer, :template).entries
+        end
+
+        it 'does not error' do
+          eager.map(&:reviewer).should == [nil]
+        end
+      end
+    end
+
+    context "when the association has scope" do
+
+      context 'when inverse of has_many' do
+        let!(:trainer1) { HmmTrainer.create!(name: 'Dave') }
+        let!(:trainer2) { HmmTrainer.create!(name: 'Ash') }
+        let!(:animal1) { HmmAnimal.create!(taxonomy: 'reptile', trainer: trainer1) }
+        let!(:animal2) { HmmAnimal.create!(taxonomy: 'bird', trainer: trainer2) }
+
+        let(:eager) do
+          HmmAnimal.includes(:trainer).to_a
+        end
+
+        it 'eager loads the included docs' do
+          expect(eager[0].trainer).to eq trainer1
+          expect(eager[1].trainer).to be_nil
+        end
+      end
+
+      context 'when inverse of has_one' do
+        let!(:trainer1) { HomTrainer.create!(name: 'Dave') }
+        let!(:trainer2) { HomTrainer.create!(name: 'Ash') }
+        let!(:animal1) { HomAnimal.create!(taxonomy: 'reptile', trainer: trainer1) }
+        let!(:animal2) { HomAnimal.create!(taxonomy: 'bird', trainer: trainer2) }
+
+        let(:eager) do
+          HomAnimal.includes(:trainer).to_a
+        end
+
+        it 'eager loads the included docs' do
+          expect(eager[0].trainer).to eq trainer1
+          expect(eager[1].trainer).to be_nil
+        end
       end
     end
 
@@ -159,5 +387,26 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
         expect(game.person_id).to eql(id)
       end
     end
+
+    context "when all the values for the belongs_to association are nil" do
+      # Query count assertions require that all queries are sent using the
+      # same connection object.
+      require_no_multi_shard
+
+      before do
+        2.times { |i| HmmTicket.create!(person: nil) }
+      end
+
+      it "only queries once for the parent documents" do
+        found_ticket = false
+        expect_query(1) do
+          HmmTicket.all.includes(:person).each do |ticket|
+            expect(ticket.person).to eq nil
+            found_ticket = true
+          end
+        end
+        expect(found_ticket).to be true
+      end
+    end
   end
 end