mongoid 7.0.13 → 8.0.8

data/spec/mongoid/document_fields_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 
@@ -41,20 +40,167 @@ describe Mongoid::Document do
       end
 
       it 'assigns as a BSON::Binary object' do
-        pending 'https://jira.mongodb.org/browse/MONGOID-4823'
-
         registry.data.should be_a(BSON::Binary)
       end
 
       it 'persists' do
-        pending 'https://jira.mongodb.org/browse/MONGOID-4823'
-
         registry.save!
 
         _registry = Registry.find(registry.id)
         _registry.data.should == BSON::Binary.new(data)
       end
     end
+
+    context 'when assigned nil' do
+      let(:data) do
+        nil
+      end
+
+      let(:registry) do
+        Registry.new(data: data)
+      end
+
+      it 'assigns nil' do
+        registry.data.should be nil
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.data.should be nil
+      end
+    end
+
+    context 'when assigned an invalid type' do
+      let(:data) do
+        true
+      end
+
+      let(:registry) do
+        Registry.new(data: data)
+      end
+
+      it 'assigns nil' do
+        registry.data.should be nil
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.data.should be nil
+      end
+    end
+  end
+
+  describe 'BSON::ObjectId field' do
+    context 'when assigned a BSON::ObjectId instance' do
+      let(:obj_id) do
+        BSON::ObjectId.new
+      end
+
+      let(:registry) do
+        Registry.new(obj_id: obj_id)
+      end
+
+      it 'does not freeze the specified data' do
+        registry
+
+        obj_id.should_not be_frozen
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.obj_id.should == obj_id
+      end
+    end
+
+    context 'when assigned a valid string' do
+      let(:obj_id) do
+        BSON::ObjectId.new.to_s
+      end
+
+      let(:registry) do
+        Registry.new(obj_id: obj_id)
+      end
+
+      it 'assigns as a BSON::Binary object' do
+        registry.obj_id.should be_a(BSON::ObjectId)
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.obj_id.should == BSON::ObjectId.from_string(obj_id)
+      end
+    end
+
+    context 'when assigned nil' do
+      let(:obj_id) do
+        nil
+      end
+
+      let(:registry) do
+        Registry.new(obj_id: obj_id)
+      end
+
+      it 'assigns nil' do
+        registry.obj_id.should be nil
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.obj_id.should be nil
+      end
+    end
+
+    context 'when assigned an invalid string' do
+      let(:obj_id) do
+        "hello"
+      end
+
+      let(:registry) do
+        Registry.new(obj_id: obj_id)
+      end
+
+      it 'assigns nil' do
+        registry.obj_id.should == "hello"
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.obj_id.should == "hello"
+      end
+    end
+
+    context 'when assigned an invalid type' do
+      let(:obj_id) do
+        :sym
+      end
+
+      let(:registry) do
+        Registry.new(obj_id: obj_id)
+      end
+
+      it 'assigns nil' do
+        registry.obj_id.should == :sym
+      end
+
+      it 'persists' do
+        registry.save!
+
+        _registry = Registry.find(registry.id)
+        _registry.obj_id.should == :sym
+      end
+    end
   end
 
   describe 'Hash field' do
@@ -85,4 +231,32 @@ describe Mongoid::Document do
       end
     end
   end
+
+  context 'Regexp field' do
+    it 'persists strings as regexp' do
+      mop = Mop.create!(regexp_field: 'foo')
+      expect(mop.regexp_field).to be_a Regexp
+      expect(Mop.find(mop.id).regexp_field).to be_a Regexp
+      expect(
+        Mop.collection.find(
+          "_id" => mop.id,
+          "regexp_field" => { "$type" => 'regex' }
+        ).count
+      ).to be == 1
+    end
+  end
+
+  context 'BSON::Regexp::Raw field' do
+    it 'round-trips BSON::Regexp::Raws' do
+      mop = Mop.create!(bson_regexp_field: BSON::Regexp::Raw.new('foo'))
+      expect(mop.bson_regexp_field).to be_a BSON::Regexp::Raw
+      expect(Mop.find(mop.id).bson_regexp_field).to be_a BSON::Regexp::Raw
+      expect(
+        Mop.collection.find(
+          "_id" => mop.id,
+          "bson_regexp_field" => { "$type" => 'regex' }
+        ).count
+      ).to be == 1
+    end
+  end
 end

data/spec/mongoid/document_persistence_context_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 

data/spec/mongoid/document_query_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::Document do
+
+  context 'when projecting with #only' do
+    before do
+      Person.create!(username: 'Dev', title: 'CEO')
+    end
+
+    let(:person) { Person.where(username: 'Dev').only(:_id, :username).first }
+
+    it 'populates specified fields only' do
+      expect do
+        person.title
+      end.to raise_error(ActiveModel::MissingAttributeError)
+      # has a default value specified in the model
+      expect do
+        person.age
+      end.to raise_error(ActiveModel::MissingAttributeError)
+      expect(person.attributes.keys).to eq(['_id', 'username'])
+    end
+
+    it 'allows writing omitted fields' do
+      pending 'https://jira.mongodb.org/browse/MONGOID-4701'
+
+      expect do
+        person.age
+      end.to raise_error(ActiveModel::MissingAttributeError)
+      person.age = 42
+      expect(person.age).to be 42
+      person.save!
+      _person = Person.find(person.id)
+      expect(_person.age).to be 42
+    end
+  end
+
+  context 'when projecting with #without' do
+    before do
+      duck = Pet.new(name: 'Duck')
+      Person.create!(username: 'Dev', title: 'CEO', pet: duck)
+    end
+
+    let(:person) { Person.where(username: 'Dev').without(:title).first }
+
+      it 'allows access to attribute of embedded document' do
+      expect(person.pet.name).to eq 'Duck'
+    end
+
+    context 'when exclusion starts with association name but is not the association' do
+
+      let(:person) { Person.where(username: 'Dev').without(:pet_).first }
+
+      it 'allows access to attribute of embedded document' do
+        expect(person.pet.name).to eq 'Duck'
+      end
+    end
+
+    context 'when exclusion starts with prefix of association name' do
+
+      let(:person) { Person.where(username: 'Dev').without(:pe).first }
+
+      it 'allows access to attribute of embedded document' do
+        expect(person.pet.name).to eq 'Duck'
+      end
+    end
+
+    context 'when another attribute of the association is excluded' do
+
+      let(:person) { Person.where(username: 'Dev').without('pet.weight').first }
+
+      it 'allows access to non-excluded attribute of embedded document' do
+        expect(person.pet.name).to eq 'Duck'
+      end
+    end
+
+    context 'when the excluded attribute of the association is retrieved' do
+
+      let(:person) { Person.where(username: 'Dev').without('pet.name').first }
+
+      it 'prohibits the retrieval' do
+        lambda do
+          person.pet.name
+        end.should raise_error(ActiveModel::MissingAttributeError)
+      end
+    end
+  end
+end

data/spec/mongoid/document_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Document 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,48 +415,12 @@ 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
       Person.new(title: "Sir")
     end
 
-    describe 'id' do
-      context 'rails < 6' do
-        max_rails_version '5.2'
-
-        it 'is a BSON::ObjectId' do
-          id = person.as_json['_id']
-          expect(id).to be_a(BSON::ObjectId)
-        end
-      end
-
-      context 'rails >= 6' do
-        min_rails_version '6.0'
-
-        it 'is a hash with $oid' do
-          id = person.as_json['_id']
-          expect(id).to be_a(Hash)
-          expect(id['$oid']).to be_a(String)
-        end
-      end
-    end
-
     context "when no options are provided" do
 
       it "does not apply any options" do
@@ -455,7 +470,7 @@ describe Mongoid::Document do
       end
     end
 
-    context ':compact option' do
+    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.
@@ -467,6 +482,26 @@ describe Mongoid::Document do
         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')
@@ -578,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
 
@@ -591,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
@@ -811,7 +846,7 @@ describe Mongoid::Document do
     end
 
     before do
-      person.save
+      person.save!
     end
 
     it "persists the correct type" do
@@ -878,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
 
@@ -947,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
@@ -1002,7 +1068,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          manager.save
+          manager.save!
         end
 
         let(:person) do
@@ -1032,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
 
@@ -1130,7 +1196,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          person.save
+          person.save!
         end
 
         let(:manager) do
@@ -1144,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
@@ -1183,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