mongoid 7.2.1 → 9.0.0

data/spec/mongoid/serializable_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -15,19 +15,19 @@ describe Mongoid::Serializable do
       expect(guitar.send(:field_names, {})).to eq(guitar.fields.except("_type").keys.sort)
     end
 
-    context "when using a custom discriminator_key" do 
-      before do 
+    context "when using a custom discriminator_key" do
+      before do
         Instrument.discriminator_key = "dkey"
       end
 
-      after do 
+      after do
         Instrument.discriminator_key = nil
       end
 
       let(:guitar) do
         Guitar.new
       end
-  
+
       it "includes _type but does not include the new discriminator key" do
         expect(guitar.send(:field_names, {})).to eq(guitar.fields.except("dkey").keys.sort)
       end
@@ -42,15 +42,11 @@ describe Mongoid::Serializable do
       end
 
       after do
-        Mongoid.include_root_in_json = false
         reload_model(:Minim)
       end
 
       context "when global config is set to true" do
-
-        before do
-          Mongoid.include_root_in_json = true
-        end
+        config_override :include_root_in_json, true
 
         it "returns true" do
           expect(Minim.public_send(meth)).to be true
@@ -68,10 +64,7 @@ describe Mongoid::Serializable do
       end
 
       context "when global config set to false" do
-
-        before do
-          Mongoid.include_root_in_json = false
-        end
+        config_override :include_root_in_json, false
 
         it "returns false" do
           expect(Minim.public_send(meth)).to be false
@@ -90,13 +83,13 @@ describe Mongoid::Serializable do
     end
 
     describe "#include_root_in_json" do
+      config_override :include_root_in_json, false
 
       before do
         reload_model(:Minim)
       end
 
       after do
-        Mongoid.include_root_in_json = false
         reload_model(:Minim)
       end
 
@@ -128,10 +121,6 @@ describe Mongoid::Serializable do
 
       context "when global config set to false" do
 
-        before do
-          Mongoid.include_root_in_json = false
-        end
-
         it "returns false" do
           expect(minim.public_send(meth)).to be false
         end
@@ -298,14 +287,7 @@ describe Mongoid::Serializable do
       end
 
       context "when include_type_for_serialization is true" do
-
-        before do
-          Mongoid.include_type_for_serialization = true
-        end
-
-        after do
-          Mongoid.include_type_for_serialization = false
-        end
+        config_override :include_type_for_serialization, true
 
         it "includes _type field" do
           expect(person.serializable_hash.keys).to include '_type'
@@ -341,7 +323,7 @@ describe Mongoid::Serializable do
 
       context "when only two attributes are loaded" do
         before do
-          person.save
+          person.save!
         end
 
         let(:from_db) do
@@ -408,7 +390,7 @@ describe Mongoid::Serializable do
       context "when the model is saved before the relation is added" do
 
         before do
-          person.save
+          person.save!
         end
 
         context "when a model has an embeds many" do
@@ -418,7 +400,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -432,7 +414,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -450,7 +432,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -464,7 +446,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -504,7 +486,7 @@ describe Mongoid::Serializable do
           context "when the ids were not loaded" do
 
             before do
-              person.save
+              person.save!
             end
 
             let(:from_db) do
@@ -612,10 +594,10 @@ describe Mongoid::Serializable do
                 end
 
                 before do
-                  person.save
+                  person.save!
                 end
 
-                it "includes the specific ralations" do
+                it "includes the specific relations" do
                   expect(relation_hash[0]["locations"].map do |location|
                     location["name"]
                   end).to include "Home"
@@ -882,16 +864,13 @@ describe Mongoid::Serializable do
     end
 
     context "when including root in json via Mongoid" do
+      config_override :include_root_in_json, false
 
       before do
         account.include_root_in_json.should be false
         Mongoid.include_root_in_json = true
       end
 
-      after do
-        Mongoid.include_root_in_json = false
-      end
-
       it "uses the mongoid configuration" do
         expect(JSON.parse(account.to_json)).to have_key("account")
       end

data/spec/mongoid/shardable_models.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 class SmMovie
   include Mongoid::Document
 
@@ -59,3 +60,17 @@ end
 class SmNotSharded
   include Mongoid::Document
 end
+
+class SmReviewAuthor
+  include Mongoid::Document
+  embedded_in :review, class_name: "SmReview", touch: false
+  field :name, type: String
+end
+
+class SmReview
+  include Mongoid::Document
+
+  embeds_one :author, class_name: "SmReviewAuthor"
+
+  shard_key "author.name" => 1
+end

data/spec/mongoid/shardable_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 require_relative './shardable_models'
@@ -28,11 +28,11 @@ describe Mongoid::Shardable do
     context 'when full syntax is used' do
       context 'with symbol value' do
         it 'sets shard key fields to symbol value' do
-          SmProducer.shard_key_fields.should == %i(age gender)
+          expect(SmProducer.shard_key_fields).to be == %i(age gender)
         end
 
         it 'sets shard config' do
-          SmProducer.shard_config.should == {
+          expect(SmProducer.shard_config).to be == {
             key: {age: 1, gender: 'hashed'},
             options: {
               unique: true,
@@ -42,37 +42,37 @@ describe Mongoid::Shardable do
         end
 
         it 'keeps hashed as string' do
-          SmProducer.shard_config[:key][:gender].should == 'hashed'
+          expect(SmProducer.shard_config[:key][:gender]).to be == 'hashed'
         end
       end
 
       context 'with string value' do
         it 'sets shard key fields to symbol value' do
-          SmActor.shard_key_fields.should == %i(age gender hello)
+          expect(SmActor.shard_key_fields).to be == %i(age gender hello)
         end
 
         it 'sets shard config' do
-          SmActor.shard_config.should == {
+          expect(SmActor.shard_config).to be == {
             key: {age: 1, gender: 'hashed', hello: 'hashed'},
             options: {},
           }
         end
 
         it 'sets hashed to string' do
-          SmActor.shard_config[:key][:gender].should == 'hashed'
+          expect(SmActor.shard_config[:key][:gender]).to be == 'hashed'
         end
       end
 
       context 'when passed association name' do
         it 'uses foreign key as shard key in shard config' do
-          SmDriver.shard_config.should == {
+          expect(SmDriver.shard_config).to be == {
             key: {age: 1, agency_id: 'hashed'},
             options: {},
           }
         end
 
         it 'uses foreign key as shard key in shard key fields' do
-          SmDriver.shard_key_fields.should == %i(age agency_id)
+          expect(SmDriver.shard_key_fields).to be == %i(age agency_id)
         end
       end
     end
@@ -80,26 +80,26 @@ describe Mongoid::Shardable do
     context 'when shorthand syntax is used' do
       context 'with symbol value' do
         it 'sets shard key fields to symbol value' do
-          SmMovie.shard_key_fields.should == %i(year)
+          expect(SmMovie.shard_key_fields).to be == %i(year)
         end
       end
 
       context 'with string value' do
         it 'sets shard key fields to symbol value' do
-          SmTrailer.shard_key_fields.should == %i(year)
+          expect(SmTrailer.shard_key_fields).to be == %i(year)
         end
       end
 
       context 'when passed association name' do
         it 'uses foreign key as shard key in shard config' do
-          SmDirector.shard_config.should == {
+          expect(SmDirector.shard_config).to be == {
             key: {agency_id: 1},
             options: {},
           }
         end
 
         it 'uses foreign key as shard key in shard key fields' do
-          SmDirector.shard_key_fields.should == %i(agency_id)
+          expect(SmDirector.shard_key_fields).to be == %i(agency_id)
         end
       end
     end
@@ -107,40 +107,190 @@ describe Mongoid::Shardable do
 
   describe '#shard_key_selector' do
     subject { instance.shard_key_selector }
-    let(:klass) { Band }
-    let(:value) { 'a-brand-name' }
+    
+    context 'when key is an immediate attribute' do
+      let(:klass) { Band }
+      let(:value) { 'a-brand-name' }
 
-    before { klass.shard_key(:name) }
+      before { klass.shard_key(:name) }
 
-    context 'when record is new' do
-      let(:instance) { klass.new(name: value) }
+      context 'when record is new' do
+        let(:instance) { klass.new(name: value) }
 
-      it { is_expected.to eq({ 'name' => value }) }
+        it { is_expected.to eq({ 'name' => value }) }
 
-      context 'changing shard key value' do
-        let(:new_value) { 'a-new-value' }
+        context 'changing shard key value' do
+          let(:new_value) { 'a-new-value' }
 
-        before do
-          instance.name = new_value
+          before do
+            instance.name = new_value
+          end
+
+          it { is_expected.to eq({ 'name' => new_value }) }
         end
+      end
+
+      context 'when record is persisted' do
+        let(:instance) { klass.create!(name: value) }
+
+        it { is_expected.to eq({ 'name' => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'a-new-value' }
 
-        it { is_expected.to eq({ 'name' => new_value }) }
+          before do
+            instance.name = new_value
+          end
+
+          it { is_expected.to eq({ 'name' => new_value }) }
+        end
       end
     end
 
-    context 'when record is persisted' do
-      let(:instance) { klass.create(name: value) }
+    context 'when key is an embedded attribute' do
+      let(:klass) { SmReview }
+      let(:value) { 'Arthur Conan Doyle' }
+      let(:key)   { 'author.name' }
 
-      it { is_expected.to eq({ 'name' => value }) }
+      context 'when record is new' do
+        let(:instance) { klass.new(author: { name: value }) }
 
-      context 'changing shard key value' do
-        let(:new_value) { 'a-new-value' }
+        it { is_expected.to eq({ key => value }) }
 
-        before do
-          instance.name = new_value
+        context 'changing shard key value' do
+          let(:new_value) { 'Jules Verne' }
+
+          before do
+            instance.author.name = new_value
+          end
+
+          it { is_expected.to eq({ key => new_value }) }
+        end
+      end
+
+      context 'when record is persisted' do
+        let(:instance) { klass.create!(author: { name: value }) }
+
+        it { is_expected.to eq({ key => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'Jules Verne' }
+
+          before do
+            instance.author.name = new_value
+          end
+
+          it { is_expected.to eq({ 'author.name' => new_value }) }
+        end
+      end
+    end
+  end
+
+  describe '#shard_key_selector_in_db' do
+    subject { instance.shard_key_selector_in_db }
+
+    context 'when key is an immediate attribute' do
+      let(:klass) { Band }
+      let(:value) { 'a-brand-name' }
+
+      before { klass.shard_key(:name) }
+
+      context 'when record is new' do
+        let(:instance) { klass.new(name: value) }
+
+        it { is_expected.to eq({ 'name' => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'a-new-value' }
+
+          before do
+            instance.name = new_value
+          end
+
+          it { is_expected.to eq({ 'name' => new_value }) }
         end
+      end
+
+      context 'when record is persisted' do
+        let(:instance) { klass.create!(name: value) }
 
         it { is_expected.to eq({ 'name' => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'a-new-value' }
+
+          before do
+            instance.name = new_value
+          end
+
+          it { is_expected.to eq({ 'name' => value }) }
+        end
+      end
+
+      context "when record is not found" do
+        let!(:instance) { klass.create!(name: value) }
+
+        before do
+          instance.destroy
+        end
+
+        it "raises a DocumentNotFound error with the shard key in the description on reload" do
+          expect do
+            instance.reload
+          end.to raise_error(Mongoid::Errors::DocumentNotFound, /Document not found for class Band with id #{instance.id.to_s} and shard key name: a-brand-name./)
+        end
+      end
+    end
+
+    context 'when key is an embedded attribute' do
+      let(:klass) { SmReview }
+      let(:value) { 'Arthur Conan Doyle' }
+      let(:key)   { 'author.name' }
+
+      context 'when record is new' do
+        let(:instance) { klass.new(author: { name: value }) }
+
+        it { is_expected.to eq({ key => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'Jules Verne' }
+
+          before do
+            instance.author.name = new_value
+          end
+
+          it { is_expected.to eq({ key => new_value }) }
+        end
+      end
+
+      context 'when record is persisted' do
+        let(:instance) { klass.create!(author: { name: value }) }
+
+        it { is_expected.to eq({ key => value }) }
+
+        context 'changing shard key value' do
+          let(:new_value) { 'Jules Verne' }
+
+          before do
+            instance.author.name = new_value
+          end
+
+          it { is_expected.to eq({ key => value }) }
+        end
+
+        context "when record is not found" do
+          let!(:instance) { klass.create!(author: { name: value }) }
+  
+          before do
+            instance.destroy
+          end
+  
+          it "raises a DocumentNotFound error with the shard key in the description on reload" do
+            expect do
+              instance.reload
+            end.to raise_error(Mongoid::Errors::DocumentNotFound, /Document not found for class SmReview with id #{instance.id.to_s} and shard key author.name: Arthur Conan Doyle./)
+          end
+        end
       end
     end
   end