mongoid 7.1.1 → 8.1.0

data/spec/mongoid/persistable/savable_spec.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
+require "support/immutable_ids"
 
 describe Mongoid::Persistable::Savable do
+  extend Mongoid::ImmutableIds
+  immutable_id_examples_as "persisted _ids are immutable"
 
   describe "#save" do
 
     let(:person) do
-      Person.create
+      Person.create!
     end
 
     let(:contextable_item) do
@@ -16,7 +18,7 @@ describe Mongoid::Persistable::Savable do
     end
 
     let(:persisted_contextable_item) do
-      ContextableItem.create(title: 'sir')
+      ContextableItem.create!(title: 'sir')
     end
 
     context "when skipping validation" do
@@ -47,7 +49,7 @@ describe Mongoid::Persistable::Savable do
       context "when saving document that is a belongs to child" do
 
         let(:account) do
-          Account.create
+          Account.create!(name: 'Foobar')
         end
 
         let(:alert) do
@@ -149,7 +151,7 @@ describe Mongoid::Persistable::Savable do
     context "when validation fails" do
 
       let(:address) do
-        person.addresses.create(city: "London")
+        person.addresses.create!(city: "London")
       end
 
       before do
@@ -165,35 +167,35 @@ describe Mongoid::Persistable::Savable do
 
       context "when performing modification and insert ops" do
 
-        let(:person) do
-          Person.create(title: "Blah")
+        let(:owner) do
+          Owner.create!(name: "Blah")
         end
 
-        let!(:address) do
-          person.addresses.build(street: "Bond St")
+        let!(:birthday) do
+          owner.birthdays.build(title: "First")
         end
 
-        let!(:name) do
-          person.create_name(first_name: "Tony")
+        let!(:scribe) do
+          owner.create_scribe(name: "Josh")
         end
 
         let(:from_db) do
-          Person.find(person.id)
+          Owner.find(owner.id)
         end
 
         before do
-          person.title = "King"
-          name.first_name = "Ryan"
+          owner.name = "King"
+          scribe.name = "Tosh"
         end
 
         it "persists with proper set and push modifiers" do
-          expect(person.atomic_updates).to eq({
+          expect(owner.atomic_updates).to eq({
             "$set" => {
-              "title" => "King",
-              "name.first_name" => "Ryan"
+              "name" => "King",
+              "scribe.name" => "Tosh"
             },
             "$push"=> {
-              "addresses" => { '$each' => [ { "_id" => address.id, "street" => "Bond St" } ] }
+              "birthdays" => { '$each' => [ { "_id" => birthday.id, "title" => "First" } ] }
             }
           })
         end
@@ -201,15 +203,15 @@ describe Mongoid::Persistable::Savable do
         context "when saving the document" do
 
           it "saves the root document" do
-            expect(person.title).to eq("King")
+            expect(owner.name).to eq("King")
           end
 
           it "saves embedded many relations" do
-            expect(person.addresses.first.street).to eq("Bond St")
+            expect(owner.birthdays.first.title).to eq("First")
           end
 
           it "saves embedded one relations" do
-            expect(person.name.first_name).to eq("Ryan")
+            expect(owner.scribe.name).to eq("Tosh")
           end
         end
       end
@@ -229,7 +231,7 @@ describe Mongoid::Persistable::Savable do
         end
 
         let!(:person) do
-          Person.create(
+          Person.create!(
             title: "Blah",
             addresses: [ address ]
           )
@@ -258,6 +260,162 @@ describe Mongoid::Persistable::Savable do
         end
       end
 
+      context 'when adding documents to embedded associations on multiple levels' do
+        let!(:truck) { Truck.create! }
+        let!(:crate) { truck.crates.create!(volume: 0.4) }
+
+        it 'persists the new documents' do
+          expect(truck.crates.size).to eq 1
+          expect(truck.crates[0].volume).to eq 0.4
+          expect(truck.crates[0].toys.size).to eq 0
+
+          truck.crates.first.toys.build(name: "Teddy bear")
+          truck.crates.build(volume: 0.8)
+
+          # The following is equivalent to the two lines above:
+          #
+          # truck.crates_attributes = {
+          #   '0' => {
+          #     "toys_attributes" => {
+          #       "0" => {
+          #         "name" => "Teddy bear"
+          #       }
+          #     },
+          #     "id" => crate.id.to_s
+          #   },
+          #   "1" => {
+          #     "volume" => 0.8
+          #   }
+          # }
+
+          expect(truck.crates.size).to eq 2
+          expect(truck.crates[0].volume).to eq 0.4
+          expect(truck.crates[0].toys.size).to eq 1
+          expect(truck.crates[0].toys[0].name).to eq "Teddy bear"
+          expect(truck.crates[1].volume).to eq 0.8
+          expect(truck.crates[1].toys.size).to eq 0
+
+          # TODO: MONGOID-5026: combine the updates so that there are
+          # no conflicts.
+          #expect(truck.atomic_updates[:conflicts]).to eq nil
+
+          expect { truck.save! }.not_to raise_error
+
+          _truck = Truck.find(truck.id)
+          expect(_truck.crates.size).to eq 2
+          expect(_truck.crates[0].volume).to eq 0.4
+          expect(_truck.crates[0].toys.size).to eq 1
+          expect(_truck.crates[0].toys[0].name).to eq "Teddy bear"
+          expect(_truck.crates[1].volume).to eq 0.8
+          expect(_truck.crates[1].toys.size).to eq 0
+        end
+      end
+
+      context 'when adding documents to embedded association and updating parent fields' do
+        let!(:truck) { Truck.create! }
+        let!(:crate) { truck.crates.create!(volume: 0.4) }
+
+        it 'performs all writes' do
+          truck.crates.build(volume: 1)
+          truck.crates.first.volume = 2
+
+          truck.save!
+
+          _truck = Truck.find(truck.id)
+          _truck.crates.length.should == 2
+          _truck.crates.first.volume.should == 2
+          _truck.crates.last.volume.should == 1
+        end
+      end
+
+      context 'when adding documents to nested embedded association and updating first association fields' do
+        let!(:truck) { Truck.create! }
+        let!(:seat) { truck.seats.create!(rating: 1) }
+
+        it 'performs all writes' do
+          truck.seats.first.armrests.build(side: 'left')
+          truck.seats.first.rating = 2
+
+          truck.save!
+
+          _truck = Truck.find(truck.id)
+          _truck.seats.length.should == 1
+          _truck.seats.first.armrests.length.should == 1
+          _truck.seats.first.armrests.first.side.should == 'left'
+        end
+      end
+
+      context 'when adding documents to nested embedded association and adding another top level association' do
+        let!(:truck) { Truck.create! }
+        let!(:crate) { truck.crates.create!(volume: 1) }
+
+        it 'performs all writes' do
+          truck.crates.first.toys.build(name: 'Bear')
+          truck.crates.build
+
+          truck.save!
+
+          _truck = Truck.find(truck.id)
+          _truck.crates.length.should == 2
+          _truck.crates.first.toys.length.should == 1
+          _truck.crates.first.toys.first.name.should == 'Bear'
+          _truck.crates.last.toys.length.should == 0
+        end
+
+        context 'when also updating first embedded top level association' do
+          it 'performs all writes' do
+            truck.crates.first.volume = 2
+            truck.crates.first.toys.build(name: 'Bear')
+            truck.crates.build
+
+            truck.save!
+
+            _truck = Truck.find(truck.id)
+            _truck.crates.length.should == 2
+            _truck.crates.first.toys.length.should == 1
+            _truck.crates.first.toys.first.name.should == 'Bear'
+            _truck.crates.last.toys.length.should == 0
+          end
+        end
+      end
+
+      context 'when adding documents to embedded associations with cascaded callbacks on update' do
+        let!(:truck) { Truck.create! }
+        let!(:seat) { truck.seats.create!(rating: 1) }
+
+        it 'persists the new documents' do
+          expect(truck.seats.size).to eq 1
+          expect(truck.seats[0].rating).to eq 1
+
+          truck.seats.build
+
+          expect { truck.save! }.not_to raise_error
+
+          _truck = Truck.find(truck.id)
+          expect(_truck.seats.size).to eq 2
+          expect(_truck.seats[0].rating).to eq 1
+          expect(_truck.seats[1].rating).to eq 100
+        end
+
+        context 'when embedded association embeds another association' do
+          it 'persists the new documents' do
+            expect(truck.seats.size).to eq 1
+            expect(truck.seats[0].rating).to eq 1
+
+            truck.seats.first.armrests.build
+            truck.seats.build
+
+            expect { truck.save! }.not_to raise_error
+
+            _truck = Truck.find(truck.id)
+            expect(_truck.seats.size).to eq 2
+            expect(_truck.seats[0].rating).to eq 2
+            expect(_truck.seats[0].armrests.length).to eq 1
+            expect(_truck.seats[1].rating).to eq 100
+          end
+        end
+      end
+
       context "when removing elements without using delete or destroy" do
 
         let!(:person) do
@@ -301,7 +459,7 @@ describe Mongoid::Persistable::Savable do
     context "when the changed attribute is not writable" do
 
       before do
-        Person.create(title: "sir")
+        Person.create!(title: "sir")
       end
 
       let(:person) do
@@ -318,7 +476,7 @@ describe Mongoid::Persistable::Savable do
       context 'when the changed attribute is aliased' do
 
         before do
-          Person.create(at: Time.now)
+          Person.create!(at: Time.now)
         end
 
         let(:person) do
@@ -327,7 +485,7 @@ describe Mongoid::Persistable::Savable do
 
         it "saves the document" do
           person.aliased_timestamp = Time.now
-          expect(person.save(validate: false)).to be true
+          expect(person.save!(validate: false)).to be true
         end
       end
     end
@@ -339,27 +497,125 @@ describe Mongoid::Persistable::Savable do
     end
 
     context "when validation context exists" do
+
       context "on new document" do
+
         it "returns true" do
           contextable_item.title = "sir"
           expect(contextable_item.save(context: :in_context)).to be true
         end
+
         it "returns false" do
           expect(contextable_item.save(context: :in_context)).to be false
         end
       end
 
       context "on persisted document" do
+
         it "returns true" do
           persisted_contextable_item.title = "lady"
           expect(persisted_contextable_item.save(context: :in_context)).to be true
         end
+
         it "returns false" do
           persisted_contextable_item.title = nil
           expect(persisted_contextable_item.save(context: :in_context)).to be false
         end
       end
     end
+
+    context "when saving a readonly document" do
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        context "when its a new document" do
+
+          let(:document) do
+            Band.new
+          end
+
+          before do
+            document.__selected_fields = { 'test' => 1 }
+            expect(document).to be_readonly
+          end
+
+          it "persists the document" do
+            expect(Band.count).to eq(0)
+            document.save!
+            expect(Band.count).to eq(1)
+          end
+        end
+
+        context "when its an old document" do
+
+          let(:document) do
+            Band.only(:name).first
+          end
+
+          before do
+            Band.create!
+            expect(document).to be_readonly
+          end
+
+          it "updates the document" do
+            document.name = "The Rolling Stones"
+            document.save!
+            expect(Band.first.name).to eq("The Rolling Stones")
+          end
+        end
+      end
+
+      context "when legacy_readonly is false" do
+        config_override :legacy_readonly, false
+
+        context "when its a new document" do
+
+          let(:document) do
+            Band.new
+          end
+
+          before do
+            document.readonly!
+            expect(document).to be_readonly
+          end
+
+          it "raises a readonly error" do
+            expect do
+              document.save!
+            end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+          end
+        end
+
+        context "when its an old document" do
+
+          let(:document) do
+            Band.first.tap(&:readonly!)
+          end
+
+          before do
+            Band.create!
+            expect(document).to be_readonly
+          end
+
+          it "raises a readonly error" do
+            document.name = "The Rolling Stones"
+            expect do
+              document.save!
+            end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+          end
+        end
+      end
+    end
+
+    context "when the _id has been modified" do
+      def invoke_operation!
+        object._id = new_id_value
+        object.save
+      end
+
+      it_behaves_like "persisted _ids are immutable"
+    end
   end
 
   describe "save!" do
@@ -471,7 +727,7 @@ describe Mongoid::Persistable::Savable do
     context "when the document has associations" do
 
       let!(:firefox) do
-        Firefox.create(name: "firefox")
+        Firefox.create!(name: "firefox")
       end
 
       let!(:writer) do

data/spec/mongoid/persistable/settable_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 
@@ -45,7 +44,7 @@ describe Mongoid::Persistable::Settable do
       end
 
       let(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:date) do
@@ -109,11 +108,11 @@ describe Mongoid::Persistable::Settable do
       end
 
       let(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:address) do
-        person.addresses.create(street: "t")
+        person.addresses.create!(street: "t")
       end
 
       let(:date) do
@@ -141,7 +140,7 @@ describe Mongoid::Persistable::Settable do
       context 'when the field is a relation' do
 
         let(:person) do
-          Person.create
+          Person.create!
         end
 
         let(:pet) do
@@ -171,7 +170,7 @@ describe Mongoid::Persistable::Settable do
     context "when executing atomically" do
 
       let(:person) do
-        Person.create(title: "sir", age: 30)
+        Person.create!(title: "sir", age: 30)
       end
 
       it "marks a dirty change for the set fields" do
@@ -181,11 +180,48 @@ describe Mongoid::Persistable::Settable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(title: "sir", age: 30)
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "title" => 1, "age" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.set(title: "miss", age: 21)
+          expect(person.title).to eq("miss")
+          expect(person.age).to eq(21)
+        end
+      end
+
+      context "when legacy_readonly is false" do
+        config_override :legacy_readonly, false
+
+        before do
+          person.readonly!
+        end
+
+        it "raises a ReadonlyDocument error" do
+          expect(person).to be_readonly
+          expect do
+            person.set(title: "miss", age: 21)
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 
   context "when dynamic attributes are not enabled" do
     let(:account) do
-      Account.create
+      Account.create!(name: 'Foobar')
     end
 
     it "raises exception for an unknown attribute " do
@@ -197,7 +233,7 @@ describe Mongoid::Persistable::Settable do
 
   context "when dynamic attributes enabled" do
     let(:person) do
-      Person.create
+      Person.create!
     end
 
     it "updates non existing attribute" do
@@ -208,7 +244,7 @@ describe Mongoid::Persistable::Settable do
 
   context "with an attribute with private setter" do
     let(:agent) do
-      Agent.create
+      Agent.create!
     end
 
     let(:title) do
@@ -462,7 +498,7 @@ describe Mongoid::Persistable::Settable do
   context 'when the field is not already set locally' do
 
     let(:church) do
-      Church.create
+      Church.create!
     end
 
     context 'when the field is a Hash type' do
@@ -512,4 +548,34 @@ describe Mongoid::Persistable::Settable do
       end
     end
   end
+
+  context "when the field being set was projected out" do
+    let(:full_agent) do
+      Agent.create!(title: "Double-Oh Eight")
+    end
+
+    let(:agent) do
+      Agent.where(_id: full_agent.id).only(:dob).first
+    end
+
+    context 'field exists in database' do
+      it "raises MissingAttributeError" do
+        lambda do
+          agent.set(title: '008')
+        end.should raise_error(ActiveModel::MissingAttributeError)
+
+        expect(agent.reload.title).to eq 'Double-Oh Eight'
+      end
+    end
+
+    context 'field does not exist in database' do
+      it "raises MissingAttributeError" do
+        lambda do
+          agent.set(number: '008')
+        end.should raise_error(ActiveModel::MissingAttributeError)
+
+        expect(agent.reload.read_attribute(:number)).to be nil
+      end
+    end
+  end
 end

data/spec/mongoid/persistable/unsettable_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 
@@ -41,7 +40,7 @@ describe Mongoid::Persistable::Unsettable do
       end
 
       let(:person) do
-        Person.create(title: "test", age: 30, dob: date)
+        Person.create!(title: "test", age: 30, dob: date)
       end
 
       context "when provided a splat of symbols" do
@@ -111,11 +110,11 @@ describe Mongoid::Persistable::Unsettable do
       end
 
       let(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:address) do
-        person.addresses.create(street: "kreuzberg", number: 40, city: "Berlin")
+        person.addresses.create!(street: "kreuzberg", number: 40, city: "Berlin")
       end
 
       context "when provided a splat of symbols" do
@@ -158,7 +157,7 @@ describe Mongoid::Persistable::Unsettable do
     context "when executing atomically" do
 
       let(:person) do
-        Person.create(title: "sir", age: 30)
+        Person.create!(title: "sir", age: 30)
       end
 
       it "marks a dirty change for the unset fields" do
@@ -168,5 +167,41 @@ describe Mongoid::Persistable::Unsettable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(title: "sir", age: 30)
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "title" => 1, "age" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.unset(:title)
+          expect(person.title).to be nil
+        end
+      end
+
+      context "when legacy_readonly is false" do
+        config_override :legacy_readonly, false
+
+        before do
+          person.readonly!
+        end
+
+        it "raises a ReadonlyDocument error" do
+          expect(person).to be_readonly
+          expect do
+            person.unset(:title)
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end