mongoid 7.0.2 → 8.1.1

data/spec/mongoid/document_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Document do
@@ -15,12 +17,12 @@ describe Mongoid::Document do
   end
 
   describe "#_destroy" do
-  
+
     it "default to false" do
       expect(Person.new._destroy).to be false
     end
   end
-  
+
   describe ".included" do
 
     let(:models) do
@@ -113,20 +115,90 @@ describe Mongoid::Document do
       end
 
       it "should clear descendants' cache" do
-        expect(Person._types).to include(descendant.to_s)
+        expect(Person._types).to include(descendant.discriminator_value)
+      end
+    end
+  end
+
+  describe "._mongoid_clear_types" do
+
+    context "when changing the discriminator_value" do
+
+      before do
+        Kangaroo._types
+        Kangaroo.discriminator_value = "dvalue"
+      end
+
+      after do
+        Kangaroo.discriminator_value = nil
+      end
+
+      it "has the correct _types" do
+        expect(Kangaroo._types).to eq(["dvalue"])
+      end
+    end
+
+    context "when changing the discriminator_value in child" do
+
+      before do
+        Shape._types
+        Circle.discriminator_value = "dvalue"
+      end
+
+      after do
+        Circle.discriminator_value = nil
+      end
+
+      it "has the correct _types" do
+        expect(Circle._types).to eq(["dvalue"])
+      end
+
+      it "has the new Circle discriminator value" do
+        expect(Shape._types).to include("dvalue")
+      end
+
+      it "doesn't have the old Circle discriminator value" do
+        expect(Shape._types).to_not include("Cirlce")
       end
     end
   end
 
   describe "#attributes" do
 
-    let(:person) do
-      Person.new(title: "Sir")
+    let!(:person) do
+      Person.create!(title: "Sir")
     end
 
     it "returns the attributes with indifferent access" do
       expect(person[:title]).to eq("Sir")
     end
+
+    context "when instantiating a new document" do
+      it "returns a Hash" do
+        expect(person.attributes.class).to eq(Hash)
+      end
+    end
+
+    context "when retrieving a document from the database" do
+
+      let(:from_db) { Person.first }
+
+      context "when legacy_attributes is false" do
+        config_override :legacy_attributes, false
+
+        it "returns a Hash" do
+          expect(from_db.attributes.class).to eq(Hash)
+        end
+      end
+
+      context "when legacy_attributes is true" do
+        config_override :legacy_attributes, true
+
+        it "returns a BSON::Document" do
+          expect(from_db.attributes.class).to eq(BSON::Document)
+        end
+      end
+    end
   end
 
   describe "#identity" do
@@ -248,27 +320,6 @@ describe Mongoid::Document do
           expect(person.game.name).to eq("Ms. Pacman")
         end
       end
-
-      context "when instantiating model" do
-
-        let(:person) do
-          Person.instantiate("_id" => BSON::ObjectId.new, "title" => "Sir")
-        end
-
-        before do
-          Person.set_callback :initialize, :after do |doc|
-            doc.title = "Madam"
-          end
-        end
-
-        after do
-          Person.reset_callbacks(:initialize)
-        end
-
-        it "runs the callbacks" do
-          expect(person.title).to eq("Madam")
-        end
-      end
     end
 
     context "when defaults are defined" do
@@ -364,21 +415,6 @@ describe Mongoid::Document do
     end
   end
 
-  describe "#to_a" do
-
-    let(:person) do
-      Person.new
-    end
-
-    let(:people) do
-      person.to_a
-    end
-
-    it "returns the document in an array" do
-      expect(people).to eq([ person ])
-    end
-  end
-
   describe "#as_json" do
 
     let!(:person) do
@@ -433,6 +469,84 @@ describe Mongoid::Document do
         end
       end
     end
+
+    context 'deprecated :compact option' do
+      # Since rails 6 differs in how it treats id fields,
+      # run this test on one version of rails. Currently rails 6 is in beta,
+      # when it is released this version should be changed to 6.
+      max_rails_version '5.2'
+
+      before do
+        # These tests require a specific set of defined attributes
+        # on the model
+        expect(church.as_json.keys.sort).to eq(%w(_id location name))
+      end
+
+      context 'deprecation' do
+        let(:church) do
+          Church.create!(name: 'St. Basil')
+        end
+
+        let(:message) do
+          '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
+        end
+
+        it 'logs a deprecation warning when :compact is given' do
+          expect(Mongoid::Warnings).to receive(:warn_as_json_compact_deprecated)
+          church.as_json(compact: true)
+        end
+
+        it 'does not log a deprecation warning when :compact is not given' do
+          expect(Mongoid::Warnings).to_not receive(:warn_as_json_compact_deprecated)
+          church.as_json
+        end
+      end
+
+      context 'there is a nil valued attribute' do
+        let(:church) do
+          Church.create!(name: 'St. Basil')
+        end
+
+        it 'returns non-nil fields and _id only' do
+          actual = church.as_json(compact: true)
+          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil')
+        end
+      end
+
+      context 'all attrbutes are nil valued' do
+        let(:church) do
+          Church.create!
+        end
+
+        it 'returns a hash with _id only' do
+          actual = church.as_json(compact: true)
+          expect(actual).to eq('_id' => church.id)
+        end
+      end
+
+      context 'there are no nil valued attributes' do
+        let(:church) do
+          Church.create!(name: 'St. Basil', location: {})
+        end
+
+        it 'returns all fields and _id' do
+          actual = church.as_json(compact: true)
+          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil',
+            'location' => {})
+        end
+      end
+
+      context 'when option is specified as a truthy value' do
+        let(:church) do
+          Church.create!(name: 'St. Basil')
+        end
+
+        it 'returns non-nil fields and _id only' do
+          actual = church.as_json(compact: 1)
+          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil')
+        end
+      end
+    end
   end
 
   describe "#as_document" do
@@ -499,12 +613,12 @@ describe Mongoid::Document do
     context "when removing an embedded document" do
 
       before do
-        person.save
+        person.save!
         person.addresses.delete(address)
       end
 
       it "does not include the document in the hash" do
-        expect(person.as_document["addresses"]).to be_empty
+        expect(person.as_document).to_not have_key("addresses")
       end
     end
 
@@ -512,9 +626,9 @@ describe Mongoid::Document do
 
       before do
         # Save the doc, then set an embeds_one relation to nil
-        person.save
+        person.save!
         person.name = nil
-        person.save
+        person.save!
       end
 
       it "does not include the document in the hash" do
@@ -732,7 +846,7 @@ describe Mongoid::Document do
     end
 
     before do
-      person.save
+      person.save!
     end
 
     it "persists the correct type" do
@@ -799,27 +913,58 @@ describe Mongoid::Document do
       end
 
       context "when no embedded documents are present" do
+        context "when using the default discriminator key" do
+          let(:person) do
+            manager.becomes(Person)
+          end
 
-        let(:person) do
-          manager.becomes(Person)
-        end
+          it "copies attributes" do
+            expect(person.title).to eq('Sir')
+          end
 
-        it "copies attributes" do
-          expect(person.title).to eq('Sir')
-        end
+          it "keeps the same object id" do
+            expect(person.id).to eq(manager.id)
+          end
 
-        it "keeps the same object id" do
-          expect(person.id).to eq(manager.id)
+          it "sets the class type" do
+            expect(person._type).to eq("Person")
+          end
+
+          it "raises an error when inappropriate class is provided" do
+            expect {
+              manager.becomes(String)
+            }.to raise_error(ArgumentError, /A class which includes Mongoid::Document is expected/)
+          end
         end
 
-        it "sets the class type" do
-          expect(person._type).to eq("Person")
+        context "when using a custom discriminator key" do
+          before do
+            Person.discriminator_key = "dkey"
+          end
+
+          after do
+            Person.discriminator_key = nil
+          end
+
+          it "sets the class type with new discriminator key" do
+            expect(person.dkey).to eq("Person")
+          end
         end
 
-        it "raises an error when inappropriate class is provided" do
-          expect {
-            manager.becomes(String)
-          }.to raise_error(ArgumentError)
+        context "when using a custom discriminator key and discriminator value" do
+          before do
+            Person.discriminator_key = "dkey"
+            Person.discriminator_value = "dvalue"
+          end
+
+          after do
+            Person.discriminator_key = nil
+            Person.discriminator_value = nil
+          end
+
+          it "sets the class type with new discriminator key" do
+            expect(person.dkey).to eq("dvalue")
+          end
         end
       end
 
@@ -868,11 +1013,11 @@ describe Mongoid::Document do
           context "when embedded doc is persisted" do
 
             let(:manager) do
-              Manager.create(title: "Sir")
+              Manager.create!(title: "Sir")
             end
 
             let!(:address) do
-              manager.addresses.create(street: "hobrecht")
+              manager.addresses.create!(street: "hobrecht")
             end
 
             let(:person) do
@@ -923,7 +1068,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          manager.save
+          manager.save!
         end
 
         let(:person) do
@@ -953,7 +1098,7 @@ describe Mongoid::Document do
       context "when the document is dirty" do
 
         before do
-          manager.save
+          manager.save!
           manager.ssn = "123-22-1234"
         end
 
@@ -1051,7 +1196,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          person.save
+          person.save!
         end
 
         let(:manager) do
@@ -1065,7 +1210,7 @@ describe Mongoid::Document do
         context "when downcasted document is saved" do
 
           before do
-            manager.save
+            manager.save!
           end
 
           it "keeps the type" do
@@ -1104,7 +1249,7 @@ describe Mongoid::Document do
       context "when the document is dirty" do
 
         before do
-          person.save
+          person.save!
           person.ssn = "123-22-1234"
         end
 

data/spec/mongoid/equality_spec.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Equality do
@@ -84,92 +85,194 @@ describe Mongoid::Equality do
 
   describe ".===" do
 
-    context "when comparable is an instance of this document" do
+    context "when legacy_triple_equals is not set" do
+      config_override :legacy_triple_equals, false
+
+      context "when comparable is an instance of this document" do
 
-      it "returns true" do
-        expect(klass === person).to be true
+        it "returns true" do
+          expect(klass === person).to be true
+        end
       end
-    end
 
-    context "when comparable is a relation of this document" do
+      context "when comparable is a relation of this document" do
+
+        let(:relation) do
+          Post.new(person: person).person
+        end
 
-      let(:relation) do
-        Post.new(person: person).person
+        it "returns true" do
+          expect(klass === relation).to be true
+        end
       end
 
-      it "returns true" do
-        expect(klass === relation).to be true
+      context "when comparable is the same class" do
+
+        it "returns false" do
+          expect(klass === Person).to be false
+        end
       end
-    end
 
-    context "when comparable is the same class" do
+      context "when the comparable is a subclass" do
 
-      it "returns true" do
-        expect(klass === Person).to be true
+        it "returns false" do
+          expect(Person === Doctor).to be false
+        end
       end
-    end
 
-    context "when the comparable is a subclass" do
+      context "when the comparable is an instance of a subclass" do
 
-      it "returns false" do
-        expect(Person === Doctor).to be false
+        it "returns true" do
+          expect(Person === Doctor.new).to be true
+        end
       end
     end
 
-    context "when the comparable is an instance of a subclass" do
+    context "when legacy_triple_equals is set" do
+      config_override :legacy_triple_equals, true
+
+      context "when comparable is an instance of this document" do
 
-      it "returns true" do
-        expect(Person === Doctor.new).to be true
+        it "returns true" do
+          expect(klass === person).to be true
+        end
       end
-    end
-  end
 
-  describe "#===" do
+      context "when comparable is a relation of this document" do
+
+        let(:relation) do
+          Post.new(person: person).person
+        end
+
+        it "returns true" do
+          expect(klass === relation).to be true
+        end
+      end
+
+      context "when comparable is the same class" do
 
-    context "when comparable is the same type" do
+        it "returns true" do
+          expect(klass === Person).to be true
+        end
+      end
 
-      context "when the instance is different" do
+      context "when the comparable is a subclass" do
 
         it "returns false" do
-          expect(person === Person.new).to be false
+          expect(Person === Doctor).to be false
         end
       end
 
-      context "when the instance is the same" do
+      context "when the comparable is an instance of a subclass" do
 
         it "returns true" do
-          expect(person === person).to be true
+          expect(Person === Doctor.new).to be true
         end
       end
     end
+  end
 
-    context "when the comparable is a subclass" do
+  describe "#===" do
 
-      it "returns false" do
-        expect(person === Doctor.new).to be false
+    context "when legacy_triple_equals is set" do
+      config_override :legacy_triple_equals, true
+
+      context "when comparable is the same type" do
+
+        context "when the instance is different" do
+
+          it "returns false" do
+            expect(person === Person.new).to be false
+          end
+        end
+
+        context "when the instance is the same" do
+
+          it "returns true" do
+            expect(person === person).to be true
+          end
+        end
+      end
+
+      context "when the comparable is a subclass" do
+
+        it "returns false" do
+          expect(person === Doctor.new).to be false
+        end
+      end
+
+      context "when comparing to a class" do
+
+        context "when the class is the same" do
+
+          it "returns true" do
+            expect(person === Person).to be true
+          end
+        end
+
+        context "when the class is a subclass" do
+
+          it "returns false" do
+            expect(person === Doctor).to be false
+          end
+        end
+
+        context "when the class is a superclass" do
+
+          it "returns true" do
+            expect(Doctor.new === Person).to be true
+          end
+        end
       end
     end
 
-    context "when comparing to a class" do
+    context "when legacy_triple_equals is not set" do
+      config_override :legacy_triple_equals, false
 
-      context "when the class is the same" do
+      context "when comparable is the same type" do
 
-        it "returns true" do
-          expect(person === Person).to be true
+        context "when the instance is different" do
+
+          it "returns false" do
+            expect(person === Person.new).to be false
+          end
+        end
+
+        context "when the instance is the same" do
+
+          it "returns true" do
+            expect(person === person).to be true
+          end
         end
       end
 
-      context "when the class is a subclass" do
+      context "when the comparable is a subclass" do
 
         it "returns false" do
-          expect(person === Doctor).to be false
+          expect(person === Doctor.new).to be false
         end
       end
 
-      context "when the class is a superclass" do
+      context "when comparing to a class" do
+        context "when the class is the same" do
 
-        it "returns true" do
-          expect(Doctor.new === Person).to be true
+          it "returns false" do
+            expect(person === Person).to be false
+          end
+        end
+
+        context "when the class is a subclass" do
+
+          it "returns false" do
+            expect(person === Doctor).to be false
+          end
+        end
+
+        context "when the class is a superclass" do
+
+          it "returns false" do
+            expect(Doctor.new === Person).to be false
+          end
         end
       end
     end

data/spec/mongoid/errors/ambiguous_relationship_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Mongoid::Errors::AmbiguousRelationship do
@@ -10,19 +12,19 @@ describe Mongoid::Errors::AmbiguousRelationship do
 
     it "contains the problem in the message" do
       expect(error.message).to include(
-        "Ambiguous relations :drugs, :evil_drugs defined on Person."
+        "Ambiguous associations :drugs, :evil_drugs defined on Person."
       )
     end
 
     it "contains the summary in the message" do
       expect(error.message).to include(
-        "When Mongoid attempts to set an inverse document of a relation in memory"
+        "When Mongoid attempts to set an inverse document of an association in memory"
       )
     end
 
     it "contains the resolution in the message" do
       expect(error.message).to include(
-        "On the :person relation on Drug you must add an :inverse_of option"
+        "On the :person association on Drug you must add an :inverse_of option"
       )
     end
   end

data/spec/mongoid/errors/callback_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Errors::Callback do