mongoid 6.4.4 → 7.5.1

data/spec/mongoid/extensions/time_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Extensions::Time do
@@ -460,4 +462,31 @@ describe Mongoid::Extensions::Time do
       expect(eom_time_mongoized.subsec.to_f.round(3)).to eq(eom_time.utc.subsec.to_f.round(3))
     end
   end
+
+  describe "__mongoize_time__" do
+
+    let(:time) do
+      Time.at(1543331265.123457)
+    end
+
+    let(:mongoized) do
+      time.__mongoize_time__
+    end
+
+    let(:expected_time) { time.in_time_zone }
+
+    context "when using active support's time zone" do
+      include_context 'using AS time zone'
+
+      it_behaves_like 'mongoizes to Time'
+      it_behaves_like 'maintains precision when mongoized'
+    end
+
+    context "when not using active support's time zone" do
+      include_context 'not using AS time zone'
+
+      it_behaves_like 'mongoizes to Time'
+      it_behaves_like 'maintains precision when mongoized'
+    end
+  end
 end

data/spec/mongoid/extensions/time_with_zone_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Extensions::TimeWithZone do
@@ -398,4 +400,35 @@ describe Mongoid::Extensions::TimeWithZone do
       expect(time.mongoize.to_f).to eq(time.to_f)
     end
   end
+
+  describe "__mongoize_time__" do
+
+    let(:time) do
+      ActiveSupport::TimeZone['Magadan'].at(1543331265.123457)
+    end
+
+    before do
+      expect(time).to be_a(ActiveSupport::TimeWithZone)
+    end
+
+    let(:mongoized) do
+      time.__mongoize_time__
+    end
+
+    let(:expected_time) { time.in_time_zone }
+
+    context "when using active support's time zone" do
+      include_context 'using AS time zone'
+
+      it_behaves_like 'mongoizes to AS::TimeWithZone'
+      it_behaves_like 'maintains precision when mongoized'
+    end
+
+    context "when not using active support's time zone" do
+      include_context 'not using AS time zone'
+
+      it_behaves_like 'mongoizes to AS::TimeWithZone'
+      it_behaves_like 'maintains precision when mongoized'
+    end
+  end
 end

data/spec/mongoid/extensions/true_class_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Extensions::TrueClass do
@@ -14,7 +16,7 @@ describe Mongoid::Extensions::TrueClass do
     context "when provided a Boolean" do
 
       it "returns true" do
-        expect(true.is_a?(Boolean)).to be true
+        expect(true.is_a?(Mongoid::Boolean)).to be true
       end
     end
 

data/spec/mongoid/extensions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe BSON::ObjectId do
@@ -8,8 +10,20 @@ describe BSON::ObjectId do
       described_class.new
     end
 
-    it "returns the $oid plus string" do
-      expect(object_id.as_json).to eq("$oid" => object_id.to_s)
+    context "when object_id_as_json_oid is not set" do
+      config_override :object_id_as_json_oid, false
+
+      it "uses bson-ruby's implementation of as_json" do
+        expect(object_id.as_json).to eq(object_id.bson_ruby_as_json)
+      end
+    end
+
+    context "when object_id_as_json_oid is set" do
+      config_override :object_id_as_json_oid, true
+
+      it "returns the $oid plus string" do
+        expect(object_id.as_json).to eq("$oid" => object_id.to_s)
+      end
     end
   end
 end

data/spec/mongoid/factory_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Factory do
@@ -75,28 +77,98 @@ describe Mongoid::Factory do
     end
 
     context "when type is not preset" do
+      context "when using the default discriminator key" do
+        let(:attributes) do
+          { "title" => "Sir" }
+        end
 
-      let(:attributes) do
-        { "title" => "Sir" }
-      end
+        let(:person) do
+          described_class.build(Person, attributes)
+        end
 
-      let(:person) do
-        described_class.build(Person, attributes)
-      end
+        it "instantiates based on the provided class" do
+          expect(person.title).to eq("Sir")
+        end
 
-      it "instantiates based on the provided class" do
-        expect(person.title).to eq("Sir")
+        context "when the type is a symbol" do
+
+          let(:person) do
+            described_class.build(Person, { :_type => "Doctor" })
+          end
+
+          it "instantiates the subclass" do
+            expect(person.class).to eq(Doctor)
+          end
+        end
       end
-    end
 
-    context "when the type is a symbol" do
+      context "when using a custom discriminator key" do
+        before do
+          Person.discriminator_key = "dkey"
+        end
 
-      let(:person) do
-        described_class.build(Person, {:_type => "Doctor"})
+        after do
+          Person.discriminator_key = nil
+        end
+
+        let(:attributes) do
+          { "title" => "Sir" }
+        end
+
+        let(:person) do
+          described_class.build(Person, attributes)
+        end
+
+        it "instantiates based on the provided class" do
+          expect(person.title).to eq("Sir")
+        end
+
+        context "when the type is a symbol" do
+
+          let(:person) do
+            described_class.build(Person, { :dkey => "Doctor" })
+          end
+
+          it "instantiates the subclass" do
+            expect(person.class).to eq(Doctor)
+          end
+        end
       end
 
-      it "instantiates the subclass" do
-        expect(person.class).to eq(Doctor)
+      context "when using a custom discriminator key and value" do
+        before do
+          Person.discriminator_key = "dkey"
+          Doctor.discriminator_value = "dvalue"
+        end
+
+        after do
+          Person.discriminator_key = nil
+          Doctor.discriminator_value = nil
+        end
+
+        let(:attributes) do
+          { "title" => "Sir", "dkey" => "dvalue" }
+        end
+
+        let(:doctor) do
+          described_class.build(Person, attributes)
+        end
+
+        it "instantiates based on the provided class" do
+          expect(doctor.title).to eq("Sir")
+        end
+
+        it "generates based on the provided class" do
+          expect(doctor).to be_a(Person)
+        end
+
+        it "sets the attributes" do
+          expect(doctor.title).to eq("Sir")
+        end
+
+        it "has the correct discriminator key/value" do
+          expect(doctor.dkey).to eq("dvalue")
+        end
       end
     end
   end
@@ -106,15 +178,65 @@ describe Mongoid::Factory do
     context "when the attributes are nil" do
 
       let(:document) do
-        described_class.from_db(Address, nil)
+        described_class.from_db(model_cls, nil)
       end
 
-      it "generates based on the provided class" do
-        expect(document).to be_a(Address)
+      context 'when model class does not use inheritance' do
+        context 'when model overwrites _id field to not have a default' do
+          let(:model_cls) { Idnodef }
+
+          it "generates based on the provided class" do
+            expect(document).to be_a(model_cls)
+          end
+
+          it "sets the attributes to empty" do
+            expect(document.attributes).to be_empty
+          end
+        end
+
+        context 'with default _id auto-assignment behavior' do
+          let(:model_cls) { Agency }
+
+          it "generates based on the provided class" do
+            expect(document).to be_a(model_cls)
+          end
+
+          it "sets the attributes to generated _id only" do
+            document.attributes.should == {'_id' => document.id}
+          end
+        end
       end
 
-      it "sets the attributes to empty" do
-        expect(document.attributes).to be_empty
+      context 'when model class is an inheritance root' do
+        let(:model_cls) { Address }
+
+        before do
+          # Ensure a child is defined
+          ShipmentAddress.superclass.should be model_cls
+        end
+
+        it "generates based on the provided class" do
+          expect(document).to be_a(model_cls)
+        end
+
+        it "sets the attributes to _type only" do
+          skip 'https://jira.mongodb.org/browse/MONGOID-5179'
+          # Note that Address provides the _id override.
+          document.attributes.should == {'_type' => 'Address'}
+        end
+      end
+
+      context 'when model class is an inheritance leaf' do
+        let(:model_cls) { ShipmentAddress }
+
+        it "generates based on the provided class" do
+          expect(document).to be_a(model_cls)
+        end
+
+        it "sets the attributes to empty" do
+          # Note that Address provides the _id override.
+          document.attributes.should == {'_type' => 'ShipmentAddress'}
+        end
       end
     end
 
@@ -176,21 +298,177 @@ describe Mongoid::Factory do
 
     context "when a type is not in the attributes" do
 
+      context "when using the default discriminator key" do
+        let(:attributes) do
+          { "title" => "Sir" }
+        end
+
+        let(:document) do
+          described_class.from_db(Person, attributes)
+        end
+
+        it "generates based on the provided class" do
+          expect(document).to be_a(Person)
+        end
+
+        it "sets the attributes" do
+          expect(document.title).to eq("Sir")
+        end
+      end
+
+      context "when using a custom discriminator key" do
+        before do
+          Person.discriminator_key = "dkey"
+        end
+
+        after do
+          Person.discriminator_key = nil
+        end
+
+        let(:attributes) do
+          { "title" => "Sir" }
+        end
+
+        let(:document) do
+          described_class.from_db(Person, attributes)
+        end
+
+        it "generates based on the provided class" do
+          expect(document).to be_a(Person)
+        end
+
+        it "sets the attributes" do
+          expect(document.title).to eq("Sir")
+        end
+      end
+
+      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
+
+        let(:attributes) do
+          { "title" => "Sir" }
+        end
+
+        let(:document) do
+          described_class.from_db(Person, attributes)
+        end
+
+        it "generates based on the provided class" do
+          expect(document).to be_a(Person)
+        end
+
+        it "sets the attributes" do
+          expect(document.title).to eq("Sir")
+        end
+
+        it "has the correct discriminator key/value" do
+          expect(document.dkey).to eq("dvalue")
+        end
+      end
+    end
+
+    context 'when type does not correspond to a Class name' do
+
       let(:attributes) do
-        { "title" => "Sir" }
+        { "title" => "Sir", "_type" => "invalid_class_name" }
       end
 
-      let(:document) do
+      let(:person) do
+        described_class.from_db(Person, attributes)
+      end
+
+      it 'raises a exception' do
+        expect {
+          person
+        }.to raise_exception(Mongoid::Errors::UnknownModel)
+      end
+    end
+
+    context 'when type does not correspond to a Class name with custom discriminator key' do
+
+      before do
+        Person.discriminator_key = "dkey"
+      end
+
+      after do
+        Person.discriminator_key = nil
+      end
+
+      let(:attributes) do
+        { "title" => "Sir", "dkey" => "invalid_class_name" }
+      end
+
+      let(:person) do
+        described_class.from_db(Person, attributes)
+      end
+
+      it 'raises a exception' do
+        expect {
+          person
+        }.to raise_exception(Mongoid::Errors::UnknownModel)
+      end
+    end
+
+    context 'when type does not correspond to a custom discriminator_value' do
+      before do
+        Person.discriminator_value = "dvalue"
+      end
+
+      after do
+        Person.discriminator_value = nil
+      end
+
+      let(:attributes) do
+        { "title" => "Sir", "_type" => "dvalue" }
+      end
+
+      let(:person) do
         described_class.from_db(Person, attributes)
       end
 
       it "generates based on the provided class" do
-        expect(document).to be_a(Person)
+        expect(person).to be_a(Person)
       end
 
       it "sets the attributes" do
-        expect(document.title).to eq("Sir")
+        expect(person.title).to eq("Sir")
+      end
+
+      it "has the correct discriminator key/value" do
+        expect(person._type).to eq("dvalue")
+      end
+    end
+
+    context 'when type is correct but the instantiation raises a NoMethodError' do
+      class BadPerson < Person
+        def self.instantiate(*args)
+          call_some_nonexistent_method(*args)
+          super
+        end
+      end
+
+      let(:attributes) do
+        { "title" => "Sir", "_type" => "BadPerson" }
       end
+
+      let(:person) do
+        described_class.from_db(BadPerson, attributes)
+      end
+
+      it 'raises a exception' do
+        expect {
+          person
+        }.to raise_exception(NoMethodError)
+      end
+
     end
   end
 end

data/spec/mongoid/fields/foreign_key_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Fields::ForeignKey do
@@ -7,7 +9,7 @@ describe Mongoid::Fields::ForeignKey do
     let(:field) do
       described_class.new(
         :vals,
-        metadata: Person.relations["preferences"],
+        association: Person.relations["preferences"],
         type: Array,
         default: [],
         identity: true
@@ -68,7 +70,7 @@ describe Mongoid::Fields::ForeignKey do
     let(:field) do
       described_class.new(
         :vals,
-        metadata: Person.relations["posts"],
+        association: Person.relations["posts"],
         type: Array,
         default: default,
         identity: true
@@ -89,7 +91,7 @@ describe Mongoid::Fields::ForeignKey do
     let(:field) do
       described_class.new(
         :vals,
-        metadata: Person.relations["posts"],
+        association: Person.relations["posts"],
         type: Array,
         default: [],
         identity: true
@@ -103,14 +105,14 @@ describe Mongoid::Fields::ForeignKey do
 
   describe "#evolve" do
 
-    let(:metadata) do
+    let(:association) do
       Person.reflect_on_association(:preferences)
     end
 
     context "when provided a document" do
 
       let(:field) do
-        described_class.new(:person_id, type: Object, metadata: metadata)
+        described_class.new(:person_id, type: Object, association: association)
       end
 
       let(:game) do
@@ -129,7 +131,7 @@ describe Mongoid::Fields::ForeignKey do
     context "when the type is an array" do
 
       let(:field) do
-        described_class.new(:preference_ids, type: Array, default: [], metadata: metadata)
+        described_class.new(:preference_ids, type: Array, default: [], association: association)
       end
 
       context "when providing a single value" do
@@ -197,12 +199,12 @@ describe Mongoid::Fields::ForeignKey do
 
           context "when the relation stores ids as strings" do
 
-            let!(:metadata) do
+            let!(:association) do
               Agent.reflect_on_association(:accounts)
             end
 
             let!(:field) do
-              described_class.new(:account_ids, type: Array, default: [], metadata: metadata)
+              described_class.new(:account_ids, type: Array, default: [], association: association)
             end
 
             let(:id_one) do
@@ -260,12 +262,12 @@ describe Mongoid::Fields::ForeignKey do
 
     context "when the type is an object" do
 
-      let(:metadata) do
+      let(:association) do
         Game.reflect_on_association(:person)
       end
 
       let(:field) do
-        described_class.new(:person_id, type: Object, metadata: metadata)
+        described_class.new(:person_id, type: Object, association: association)
       end
 
       context "when providing a single value" do
@@ -312,12 +314,12 @@ describe Mongoid::Fields::ForeignKey do
 
         context "when the relation stores string ids" do
 
-          let(:metadata) do
+          let(:association) do
             Comment.reflect_on_association(:account)
           end
 
           let(:field) do
-            described_class.new(:person_id, type: Object, metadata: metadata)
+            described_class.new(:person_id, type: Object, association: association)
           end
 
           context "when the value is an id string" do
@@ -384,12 +386,12 @@ describe Mongoid::Fields::ForeignKey do
 
           context "when the relation stores ids as strings" do
 
-            let(:metadata) do
+            let(:association) do
               Comment.reflect_on_association(:account)
             end
 
             let(:field) do
-              described_class.new(:person_id, type: Object, metadata: metadata)
+              described_class.new(:person_id, type: Object, association: association)
             end
 
             let(:id_one) do
@@ -445,14 +447,14 @@ describe Mongoid::Fields::ForeignKey do
       end
     end
 
-    context "when the metadata is polymoprhic" do
+    context "when the association is polymoprhic" do
 
-      let(:metadata) do
+      let(:association) do
         Agent.reflect_on_association(:names)
       end
 
       let(:field) do
-        described_class.new(:nameable_id, type: Object, metadata: metadata)
+        described_class.new(:nameable_id, type: Object, association: association)
       end
 
       let(:value) do
@@ -464,7 +466,7 @@ describe Mongoid::Fields::ForeignKey do
       end
 
       it "does not change the foreign key" do
-        expect(evolved).to be(value)
+        expect(evolved).to eq(BSON::ObjectId.from_string(value))
       end
     end
   end
@@ -500,12 +502,8 @@ describe Mongoid::Fields::ForeignKey do
 
       context "when the array is object ids" do
 
-        let(:metadata) do
-          Mongoid::Relations::Metadata.new(
-            inverse_class_name: "Game",
-            name: :person,
-            relation: Mongoid::Relations::Referenced::In
-          )
+        let(:association) do
+          Game.relations["person"]
         end
 
         let(:field) do
@@ -514,7 +512,7 @@ describe Mongoid::Fields::ForeignKey do
             type: Array,
             default: [],
             identity: true,
-            metadata: metadata,
+            association: association,
             overwrite: true
           )
         end
@@ -589,12 +587,8 @@ describe Mongoid::Fields::ForeignKey do
 
       context "when the array is object ids" do
 
-        let(:metadata) do
-          Mongoid::Relations::Metadata.new(
-            inverse_class_name: "Game",
-            name: :person,
-            relation: Mongoid::Relations::Referenced::In
-          )
+        let(:association) do
+          Game.relations['person']
         end
 
         let(:field) do
@@ -603,7 +597,7 @@ describe Mongoid::Fields::ForeignKey do
             type: Object,
             default: nil,
             identity: true,
-            metadata: metadata,
+            association: association,
             overwrite: true
           )
         end