mongoid 8.0.3 → 8.1.0

data/spec/mongoid/persistable/logical_spec.rb

@@ -155,5 +155,42 @@ describe Mongoid::Persistable::Logical do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(age: 10, score: 100)
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "age" => 1, "score" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.bit(age: { and: 6 }, score: { or: 122 })
+          expect(person.age).to eq(2)
+          expect(person.score).to eq(126)
+        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.bit(age: { and: 6 }, score: { or: 122 })
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end

data/spec/mongoid/persistable/poppable_spec.rb

@@ -127,5 +127,41 @@ describe Mongoid::Persistable::Poppable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(test_array: [1, 2, 3])
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.pop(test_array: 1)
+          expect(person.test_array).to eq([ 1, 2 ])
+        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.pop(test_array: 1)
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end

data/spec/mongoid/persistable/pullable_spec.rb

@@ -127,6 +127,42 @@ describe Mongoid::Persistable::Pullable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(test_array: [ 1, 1, 2, 3 ])
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.pull(test_array: 1)
+          expect(person.test_array).to eq([ 2, 3 ])
+        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.pull(test_array: 1)
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 
   describe "#pull_all" do
@@ -254,5 +290,41 @@ describe Mongoid::Persistable::Pullable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(test_array: [ 1, 1, 2, 3, 4 ])
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.pull_all(test_array: [ 1, 2 ])
+          expect(person.test_array).to eq([ 3, 4 ])
+        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.pull_all(test_array: [ 1, 2 ])
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end

data/spec/mongoid/persistable/pushable_spec.rb

@@ -204,6 +204,42 @@ describe Mongoid::Persistable::Pushable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(test_array: [ 1, 2, 3 ])
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.add_to_set(test_array: [ 1, 4 ])
+          expect(person.test_array).to eq([ 1, 2, 3, 4 ])
+        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.add_to_set(test_array: [ 1, 4 ])
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 
   describe "#push" do
@@ -349,5 +385,41 @@ describe Mongoid::Persistable::Pushable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(test_array: [ 1, 2, 3 ])
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.push(test_array: [ 1, 4 ])
+          expect(person.test_array).to eq([ 1, 2, 3, 1, 4 ])
+        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.push(test_array: [ 1, 4 ])
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end

data/spec/mongoid/persistable/renamable_spec.rb

@@ -147,5 +147,41 @@ describe Mongoid::Persistable::Renamable do
         end
       end
     end
+
+    context "when executing on a readonly document" do
+
+      let(:person) do
+        Person.create!(title: "sir")
+      end
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        before do
+          person.__selected_fields = { "test_array" => 1 }
+        end
+
+        it "persists the changes" do
+          expect(person).to be_readonly
+          person.rename title: :salutation
+          expect(person.reload.salutation).to eq("sir")
+        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.rename(title: :salutation)
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end

data/spec/mongoid/persistable/savable_spec.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 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
 
@@ -520,6 +523,99 @@ describe Mongoid::Persistable::Savable do
         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

data/spec/mongoid/persistable/settable_spec.rb

@@ -180,6 +180,43 @@ 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

data/spec/mongoid/persistable/unsettable_spec.rb

@@ -167,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

data/spec/mongoid/persistable/updatable_spec.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require "spec_helper"
+require "support/immutable_ids"
 
 describe Mongoid::Persistable::Updatable do
+  extend Mongoid::ImmutableIds
+  immutable_id_examples_as "persisted _ids are immutable"
 
   describe "#update_attribute" do
 
@@ -231,21 +234,17 @@ describe Mongoid::Persistable::Updatable do
     end
 
     context "when persisting a localized field" do
+      with_default_i18n_configs
 
       let!(:product) do
         Product.create!(description: "The bomb")
       end
 
       before do
-        I18n.enforce_available_locales = false
         ::I18n.locale = :de
         product.update_attribute(:description, "Die Bombe")
       end
 
-      after do
-        ::I18n.locale = :en
-      end
-
       let(:attributes) do
         product.attributes["description"]
       end
@@ -450,6 +449,14 @@ describe Mongoid::Persistable::Updatable do
         end
       end
     end
+
+    context 'when the field is _id' do
+      def invoke_operation!
+        object.update_attribute "_id", new_id_value
+      end
+
+      it_behaves_like "persisted _ids are immutable"
+    end
   end
 
   [:update_attributes, :update].each do |method|
@@ -470,29 +477,6 @@ describe Mongoid::Persistable::Updatable do
         end
       end
 
-      context "when validation passes" do
-
-        let(:person) do
-          Person.create!
-        end
-
-        let!(:saved) do
-          person.update_attributes!(pets: false)
-        end
-
-        let(:from_db) do
-          Person.find(person.id)
-        end
-
-        it "returns true" do
-          expect(saved).to be true
-        end
-
-        it "saves the attributes" do
-          expect(from_db.pets).to be false
-        end
-      end
-
       context "when the document has been destroyed" do
         max_server_version '4.9'
 
@@ -721,6 +705,14 @@ describe Mongoid::Persistable::Updatable do
           end
         end
       end
+
+      context 'when the _id is one of the fields' do
+        def invoke_operation!
+          object.update_attributes _id: new_id_value
+        end
+  
+        it_behaves_like "persisted _ids are immutable"
+      end
     end
   end
 

data/spec/mongoid/persistable/upsertable_spec.rb

@@ -42,8 +42,10 @@ describe Mongoid::Persistable::Upsertable do
           end
         end
 
+        let(:options) { {} }
+
         before do
-          updated.upsert
+          updated.upsert(options)
         end
 
         it "updates the existing document" do
@@ -54,19 +56,46 @@ describe Mongoid::Persistable::Upsertable do
           expect(existing).to be_persisted
         end
 
-        context 'when existing document contains other fields' do
-          let!(:existing) do
-            Band.create!(name: "Photek", views: 42)
+        shared_examples "replaces the existing fields" do
+          it 'replaces the existing fields' do
+            Band.count.should == 1
+
+            existing.reload
+            existing.views.should be nil
+            existing.name.should == 'Tool'
           end
+        end
 
-          it 'removes the existing fields' do
+        shared_examples "retains the existing fields" do
+          it 'retains the existing fields' do
             Band.count.should == 1
 
             existing.reload
-            existing.views.should be nil
+            existing.views.should eq(42)
             existing.name.should == 'Tool'
           end
         end
+
+        context 'when existing document contains other fields' do
+          let!(:existing) do
+            Band.create!(name: "Photek", views: 42)
+          end
+
+          context "when not passing any options" do
+            let(:options) { {} }
+            it_behaves_like "replaces the existing fields"
+          end
+
+          context "when passing replace: false" do
+            let(:options) { { replace: false } }
+            it_behaves_like "retains the existing fields"
+          end
+
+          context "when passing replace: true" do
+            let(:options) { { replace: true } }
+            it_behaves_like "replaces the existing fields"
+          end
+        end
       end
 
       context "when no matching document exists in the db" do
@@ -118,5 +147,50 @@ describe Mongoid::Persistable::Upsertable do
         end
       end
     end
+
+    context "when the document is readonly" do
+
+      context "when legacy_readonly is true" do
+        config_override :legacy_readonly, true
+
+        let!(:existing) do
+          Band.create!(name: "Photek")
+        end
+
+        before do
+          existing.name = "Depeche Mode"
+        end
+
+        let!(:upsert) do
+          existing.upsert
+        end
+
+        it "updates the existing document" do
+          expect(existing.reload.name).to eq("Depeche Mode")
+        end
+
+        it "returns true" do
+          expect(upsert).to be true
+        end
+      end
+
+      context "when legacy_readonly is false" do
+        config_override :legacy_readonly, false
+
+        let!(:existing) do
+          Band.create!(name: "Photek").tap(&:readonly!)
+        end
+
+        before do
+          existing.name = "Depeche Mode"
+        end
+
+        it 'raises a ReadonlyDocument error' do
+          expect do
+            existing.upsert
+          end.to raise_error(Mongoid::Errors::ReadonlyDocument)
+        end
+      end
+    end
   end
 end