mongoid 7.1.5 → 7.2.1

data/spec/integration/atomic/modifiers_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Mongoid::Atomic::Modifiers do
+
+  let(:modifiers) do
+    described_class.new
+  end
+
+  context 'when performing multiple operations with similar keys' do
+
+    let(:pushes) do
+      { "addresses.0.locations" => { "street" => "Bond St" } }
+    end
+
+    let(:similar1) do
+      { "dresses" => { "color" => "red" } }
+    end
+
+    let(:similar2) do
+      { "ses.0.foo" => { "baz" => "qux" } }
+    end
+
+    before do
+      modifiers.send(operation, pushes)
+      modifiers.send(operation, similar1)
+      modifiers.send(operation, similar2)
+    end
+
+    context "push" do
+      let(:operation) { :push }
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq({ "$push" => {
+                                    "addresses.0.locations" => { '$each' => [{ "street" => "Bond St" }] },
+                                    "dresses" => { '$each' => [{ "color" => "red" }] },
+                                    "ses.0.foo" => { '$each' => [{ "baz" => "qux" }] }
+                                 } })
+      end
+    end
+
+    context "pull" do
+      let(:operation) { :pull }
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq({ "$pull" => {
+                                    "addresses.0.locations" => { "street" => "Bond St" },
+                                    "dresses" => { "color" => "red" },
+                                    "ses.0.foo" => { "baz" => "qux" },
+                                 } })
+      end
+    end
+
+    context "pull_all" do
+      let(:operation) { :pull_all }
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq({ "$pullAll" => {
+                                    "addresses.0.locations" => { "street" => "Bond St" },
+                                    "dresses" => { "color" => "red" },
+                                    "ses.0.foo" => { "baz" => "qux" },
+                                 } })
+      end
+    end
+
+    context "add_to_set" do
+      let(:operation) { :add_to_set }
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq({ "$addToSet" => {
+                                    "addresses.0.locations" => { '$each' => { "street" => "Bond St" } },
+                                    "dresses" => { '$each' => { "color" => "red" } },
+                                    "ses.0.foo" => { '$each' => { "baz" => "qux" } }
+                                 } })
+      end
+    end
+
+    context "set" do
+      let(:operation) { :set }
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq({ "$set" => {
+                                    "addresses.0.locations" => { "street" => "Bond St" },
+                                    "dresses" => { "color" => "red" },
+                                    "ses.0.foo" => { "baz" => "qux" },
+                                 } })
+      end
+    end
+
+    context "unset" do
+      let(:operation) { :unset }
+
+      let(:pushes) do
+        [:foobar]
+      end
+
+      let(:similar1) do
+        [:foo]
+      end
+
+      let(:similar2) do
+        [:bar]
+      end
+
+      it "adds all modifiers to top level" do
+        expect(modifiers).to eq("$unset" => {
+          foobar: true,
+          foo: true,
+          bar: true,
+        })
+      end
+    end
+  end
+
+end

data/spec/integration/callbacks_models.rb

@@ -0,0 +1,49 @@
+class Galaxy
+  include Mongoid::Document
+
+  field :age, type: Integer
+
+  before_validation :set_age
+
+  embeds_many :stars
+
+  private
+
+  def set_age
+    self.age ||= 100_000
+  end
+end
+
+class Star
+  include Mongoid::Document
+
+  embedded_in :galaxy
+
+  field :age, type: Integer
+
+  before_validation :set_age
+
+  embeds_many :planets
+
+  private
+
+  def set_age
+    self.age ||= 42_000
+  end
+end
+
+class Planet
+  include Mongoid::Document
+
+  embedded_in :star
+
+  field :age, type: Integer
+
+  before_validation :set_age
+
+  private
+
+  def set_age
+    self.age ||= 2_000
+  end
+end

data/spec/integration/callbacks_spec.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+require_relative './callbacks_models'
+
+describe 'callbacks integration tests' do
+  context 'when modifying attributes in a callback' do
+
+    context 'when creating top-level document' do
+      context 'top level document' do
+        let(:instance) do
+          Galaxy.create!
+        end
+
+        it 'writes the attribute value into the model' do
+          instance.age.should == 100_000
+        end
+
+        it 'persists the attribute value' do
+          Galaxy.find(instance.id).age.should == 100_000
+        end
+      end
+
+      context 'embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.age.should == 42_000
+          end
+
+          it 'persists the attribute value' do
+            Galaxy.find(instance.id).stars.first.age.should == 42_000
+          end
+        end
+
+        context 'set as a document instance' do
+          let(:instance) do
+            Galaxy.create!(stars: [Star.new])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          let(:instance) do
+            Galaxy.create!(stars: [{}])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+
+      context 'nested embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.planets.first.age.should == 2_000
+          end
+
+          it 'persists the attribute value' do
+            Galaxy.find(instance.id).stars.first.planets.first.age.should == 2_000
+          end
+        end
+
+        context 'set as a document instance' do
+          let(:instance) do
+            Galaxy.create!(stars: [Star.new(
+              planets: [Planet.new],
+            )])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          let(:instance) do
+            Galaxy.create!(stars: [
+              planets: [{}],
+            ])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+    end
+
+    context 'when updating top-level document via #save' do
+      let!(:instance) do
+        Galaxy.create!
+      end
+
+      context 'embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.age.should == 42_000
+          end
+
+          it 'persists the attribute value' do
+            Galaxy.find(instance.id).stars.first.age.should == 42_000
+          end
+        end
+
+        context 'set as a document instance' do
+          before do
+            instance.stars = [Star.new]
+            instance.save!
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          before do
+            instance.stars = [{}]
+            instance.save!
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+
+      context 'nested embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.planets.first.age.should == 2_000
+          end
+
+          it 'persists the attribute value' do
+            Galaxy.find(instance.id).stars.first.planets.first.age.should == 2_000
+          end
+        end
+
+        context 'set as a document instance' do
+          before do
+            instance.stars = [Star.new(planets: [Planet.new])]
+            instance.save!
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          before do
+            instance.stars = [planets: [{}]]
+            instance.save!
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+    end
+
+    context 'when updating top-level document via #update_attributes' do
+      let!(:instance) do
+        Galaxy.create!
+      end
+
+      context 'embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.age.should == 42_000
+          end
+
+          it 'persists the attribute value' do
+            Galaxy.find(instance.id).stars.first.age.should == 42_000
+          end
+        end
+
+        context 'set as a document instance' do
+          before do
+            instance.update_attributes(stars: [Star.new])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          before do
+            instance.update_attributes(stars: [{}])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+
+      context 'nested embedded document' do
+        shared_examples 'persists the attribute value' do
+          it 'writes the attribute value into the model' do
+            instance.stars.first.planets.first.age.should == 2_000
+          end
+
+          it 'persists the attribute value' do
+            pending 'MONGOID-4476'
+
+            Galaxy.find(instance.id).stars.first.planets.first.age.should == 2_000
+          end
+        end
+
+        context 'set as a document instance' do
+          before do
+            instance.update_attributes(stars: [Star.new(planets: [Planet.new])])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+
+        context 'set as attributes on parent' do
+          before do
+            instance.update_attributes(stars: [planets: [{}]])
+          end
+
+          include_examples 'persists the attribute value'
+        end
+      end
+    end
+  end
+end

data/spec/integration/discriminator_key_spec.rb

@@ -0,0 +1,354 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe "#discriminator_key" do 
+
+  context "when the discriminator key is not set on a class" do
+    let(:piano) do 
+      Piano.new
+    end
+
+    let(:guitar) do 
+      Guitar.new
+    end  
+    
+    it "sets the child discriminator key to _type: Piano" do
+      expect(piano._type).to eq("Piano")
+    end
+
+    it "sets the child discriminator key to _type: Guitar" do
+      expect(guitar._type).to eq("Guitar")
+    end
+  end
+  
+  context "when the discriminator key is changed in the parent" do
+    before do
+      Instrument.discriminator_key = "hello2"
+    end
+
+    after do
+      Instrument.discriminator_key = nil
+    end
+
+    let(:piano) do 
+      Piano.new
+    end
+
+    let(:guitar) do 
+      Guitar.new
+    end
+
+    it "changes in the child class: Piano" do
+      expect(piano.hello2).to eq("Piano")
+    end
+
+    it "changes in the child class: Guitar" do
+      expect(guitar.hello2).to eq("Guitar")
+    end
+  end
+
+  context "when the discriminator key is changed at the base level" do
+    context "after class creation" do
+      before do
+        class GlobalIntDiscriminatorParent
+          include Mongoid::Document
+        end
+        
+        class GlobalIntDiscriminatorChild < GlobalIntDiscriminatorParent
+        end
+        
+        Mongoid.discriminator_key = "test"
+      end
+
+      after do
+        Mongoid.discriminator_key = "_type"
+      end
+
+      let(:child) do 
+        GlobalIntDiscriminatorChild.new
+      end
+
+      it "has a discriminator key _type" do 
+        expect(child._type).to eq("GlobalIntDiscriminatorChild")
+      end
+
+      it "does not have the new global value as a field" do
+        expect(defined?(child.test)).to be nil
+      end
+    end
+
+    context "before class creation" do
+      before do
+        Mongoid.discriminator_key = "test"
+
+        class PreGlobalIntDiscriminatorParent
+          include Mongoid::Document
+        end
+        
+        class PreGlobalIntDiscriminatorChild < PreGlobalIntDiscriminatorParent
+        end
+      end
+
+      after do
+        Mongoid.discriminator_key = "_type"
+      end
+
+      let(:child) do 
+        PreGlobalIntDiscriminatorChild.new
+      end
+
+      it "creates a field with new discriminator key" do 
+        expect(child.test).to eq("PreGlobalIntDiscriminatorChild")
+      end
+      
+      it "does not have the default value as a field" do
+        expect(defined?(child._type)).to be nil
+      end
+    end
+  end
+
+  context "when the discriminator key is changed in the parent" do 
+    context "after child class creation" do
+      before do
+        class LocalIntDiscriminatorParent
+          include Mongoid::Document
+        end
+
+        class LocalIntDiscriminatorChild < LocalIntDiscriminatorParent
+        end
+
+        LocalIntDiscriminatorParent.discriminator_key = "test2"
+      end
+
+      let(:child) do 
+        LocalIntDiscriminatorChild.new
+      end
+
+      it "still has _type field in the child" do 
+        expect(child._type).to include("LocalIntDiscriminatorChild")
+      end
+
+      it "has the new field in the child" do 
+        expect(child.test2).to include("LocalIntDiscriminatorChild")
+      end
+    end
+
+    context "before child class creation" do
+      before do
+        class PreLocalIntDiscriminatorParent
+          include Mongoid::Document
+          self.discriminator_key = "test2"
+        end
+
+        class PreLocalIntDiscriminatorChild < PreLocalIntDiscriminatorParent
+        end
+      end
+
+      let(:child) do 
+        PreLocalIntDiscriminatorChild.new
+      end
+
+      it "creates a new field in the child" do 
+        expect(child.test2).to include("PreLocalIntDiscriminatorChild")
+      end
+
+      it "does not have the default value as a field" do
+        expect(defined?(child._type)).to be nil
+      end
+    end
+  end
+
+  context "when adding to the db" do 
+    context "when changing the discriminator_key" do
+      before do 
+        class DBDiscriminatorParent
+          include Mongoid::Document
+          self.discriminator_key = "dkey"
+        end
+
+        class DBDiscriminatorChild < DBDiscriminatorParent
+        end
+        DBDiscriminatorChild.create!
+      end
+      
+      it "has the correct count" do 
+        expect(DBDiscriminatorChild.count).to eq(1)
+      end
+
+      it "has the correct count in the parent" do 
+        expect(DBDiscriminatorParent.count).to eq(1)
+      end
+    end
+
+    context "when changing the discriminator_key after saving to the db" do
+      before do 
+        class DBDiscriminatorParent
+          include Mongoid::Document
+        end
+        
+        class DBDiscriminatorChild < DBDiscriminatorParent
+        end
+        DBDiscriminatorChild.create!
+        DBDiscriminatorParent.discriminator_key = "dkey2"
+        DBDiscriminatorChild.create!
+      end
+      
+      it "only finds the documents with the new discriminator key" do 
+        expect(DBDiscriminatorChild.count).to eq(1)
+      end
+
+      it "has the correct count in the parent" do 
+        expect(DBDiscriminatorParent.count).to eq(2)
+      end
+    end
+  end
+
+  context "documentation tests" do
+
+    context "Example 1" do
+      before do
+        class Example1Shape
+          include Mongoid::Document
+          field :x, type: Integer
+          field :y, type: Integer
+          embedded_in :canvas
+  
+          self.discriminator_key = "shape_type"
+        end
+  
+        class Example1Circle < Example1Shape
+          field :radius, type: Float
+        end
+  
+        class Example1Rectangle < Example1Shape
+          field :width, type: Float
+          field :height, type: Float
+        end
+      end
+  
+      let(:rectangle) do 
+        Example1Rectangle.new
+      end
+  
+      let(:circle) do 
+        Example1Circle.new
+      end
+  
+      it "has the new discriminator key: Rectangle" do 
+        expect(rectangle.shape_type).to eq("Example1Rectangle")
+      end
+  
+      it "does not have the default discriminator key: Rectangle" do
+        expect(defined?(rectangle._type)).to be nil
+      end
+  
+      it "has the new discriminator key: Circle" do 
+        expect(circle.shape_type).to eq("Example1Circle")
+      end
+  
+      it "does not have the default discriminator key: Circle" do
+        expect(defined?(circle._type)).to be nil
+      end
+    end
+  
+    context "Example 2" do
+      before do
+        class Example2Shape
+          include Mongoid::Document
+          field :x, type: Integer
+          field :y, type: Integer
+          embedded_in :canvas
+        end
+  
+        class Example2Circle < Example2Shape
+          field :radius, type: Float
+        end
+  
+        class Example2Rectangle < Example2Shape
+          field :width, type: Float
+          field :height, type: Float
+        end
+  
+        Example2Shape.discriminator_key = "shape_type"
+      end
+  
+      let(:rectangle) do 
+        Example2Rectangle.new
+      end
+  
+      let(:circle) do 
+        Example2Circle.new
+      end
+  
+      it "has the new discriminator key: Rectangle" do 
+        expect(rectangle.shape_type).to eq("Example2Rectangle")
+      end
+  
+      it "has default discriminator key: Rectangle" do
+        expect(rectangle._type).to eq("Example2Rectangle")
+      end
+  
+      it "has the new discriminator key: Circle" do 
+        expect(circle.shape_type).to eq("Example2Circle")
+      end
+  
+      it "has default discriminator key: Circle" do
+        expect(circle._type).to eq("Example2Circle")
+      end
+    end
+  
+    context "Example 3" do
+      before do
+  
+        Mongoid.discriminator_key = "shape_type"
+        
+        class Example3Shape
+          include Mongoid::Document
+          field :x, type: Integer
+          field :y, type: Integer
+          embedded_in :canvas
+        end
+  
+        class Example3Circle < Example3Shape
+          field :radius, type: Float
+        end
+  
+        class Example3Rectangle < Example3Shape
+          field :width, type: Float
+          field :height, type: Float
+        end
+  
+      end
+
+      after do 
+        Mongoid.discriminator_key = "_type"
+      end
+  
+      let(:rectangle) do 
+        Example3Rectangle.new
+      end
+  
+      let(:circle) do 
+        Example3Circle.new
+      end
+  
+      it "has the new discriminator key: Rectangle" do 
+        expect(rectangle.shape_type).to eq("Example3Rectangle")
+      end
+  
+      it "does not have the default discriminator key: Rectangle" do
+        expect(defined?(rectangle._type)).to be nil
+      end
+  
+      it "has the new discriminator key: Circle" do 
+        expect(circle.shape_type).to eq("Example3Circle")
+      end
+  
+      it "does not have the default discriminator key: Circle" do
+        expect(defined?(circle._type)).to be nil
+      end
+    end
+  end
+end