mongoid 7.0.2 → 8.1.1

data/spec/mongoid/serializable_spec.rb

@@ -1,43 +1,138 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Serializable do
 
   describe "#field_names" do
 
-    let(:band) do
-      Band.new
+    let(:guitar) do
+      Guitar.new
     end
 
     it "does not duplicate fields" do
-      expect(band.send(:field_names, {})).to eq(band.fields.except("_type").keys.sort)
+      expect(guitar.send(:field_names, {})).to eq(guitar.fields.except("_type").keys.sort)
     end
-  end
 
-  describe ".include_root_in_json" do
+    context "when using a custom discriminator_key" do
+      before do
+        Instrument.discriminator_key = "dkey"
+      end
 
-    let(:person) do
-      Person.new
+      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
     end
+  end
 
-    context "when config set to true" do
+  %i(include_root_in_json include_root_in_json?).each do |meth|
+    describe ".#{meth}" do
 
       before do
-        Mongoid.include_root_in_json = true
+        reload_model(:Minim)
       end
 
-      it "returns true" do
-        expect(person.include_root_in_json).to be true
+      after do
+        reload_model(:Minim)
+      end
+
+      context "when global config is set to true" do
+        config_override :include_root_in_json, true
+
+        it "returns true" do
+          expect(Minim.public_send(meth)).to be true
+        end
+
+        context 'when value is overridden to false in the model class' do
+          before do
+            Minim.include_root_in_json = false
+          end
+
+          it 'returns false' do
+            expect(Minim.public_send(meth)).to be false
+          end
+        end
+      end
+
+      context "when global config set to false" do
+        config_override :include_root_in_json, false
+
+        it "returns false" do
+          expect(Minim.public_send(meth)).to be false
+        end
+
+        context 'when value is overridden to true in the model class' do
+          before do
+            Minim.include_root_in_json = true
+          end
+
+          it 'returns true' do
+            expect(Minim.public_send(meth)).to be true
+          end
+        end
       end
     end
 
-    context "when config set to false" do
+    describe "#include_root_in_json" do
+      config_override :include_root_in_json, false
 
       before do
-        Mongoid.include_root_in_json = false
+        reload_model(:Minim)
+      end
+
+      after do
+        reload_model(:Minim)
+      end
+
+      let(:minim) do
+        Minim.new
+      end
+
+      context "when global config is set to true" do
+
+        before do
+          Minim.include_root_in_json.should be false
+          Mongoid.include_root_in_json = true
+        end
+
+        it "returns true" do
+          expect(minim.public_send(meth)).to be true
+        end
+
+        context 'when value is overridden to false in the model class' do
+          before do
+            Minim.include_root_in_json = false
+          end
+
+          it 'returns false' do
+            expect(minim.public_send(meth)).to be false
+          end
+        end
       end
 
-      it "returns false" do
-        expect(person.include_root_in_json).to be false
+      context "when global config set to false" do
+
+        it "returns false" do
+          expect(minim.public_send(meth)).to be false
+        end
+
+        context 'when value is overridden to true in the model class' do
+          before do
+            Minim.include_root_in_json = true
+          end
+
+          it 'returns true' do
+            expect(minim.public_send(meth)).to be true
+          end
+        end
       end
     end
   end
@@ -191,14 +286,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'
@@ -234,7 +322,7 @@ describe Mongoid::Serializable do
 
       context "when only two attributes are loaded" do
         before do
-          person.save
+          person.save!
         end
 
         let(:from_db) do
@@ -301,7 +389,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
@@ -311,7 +399,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -325,7 +413,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -343,7 +431,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -357,7 +445,7 @@ describe Mongoid::Serializable do
           end
 
           before do
-            person.save
+            person.save!
           end
 
           it "includes the relation" do
@@ -397,7 +485,7 @@ describe Mongoid::Serializable do
           context "when the ids were not loaded" do
 
             before do
-              person.save
+              person.save!
             end
 
             let(:from_db) do
@@ -505,10 +593,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"
@@ -770,32 +858,54 @@ describe Mongoid::Serializable do
 
   describe "#to_json" do
 
-    let(:person) do
-      Person.new
+    let(:account) do
+      Account.new
     end
 
-    context "when including root in json" do
+    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
 
       it "uses the mongoid configuration" do
-        expect(person.to_json).to include("person")
+        expect(JSON.parse(account.to_json)).to have_key("account")
+      end
+    end
+
+    context "when including root in json via class" do
+
+      before do
+        account.include_root_in_json.should be false
+        Account.include_root_in_json = true
+      end
+
+      after do
+        Account.include_root_in_json = false
+      end
+
+      it "uses the class configuration" do
+        expect(JSON.parse(account.to_json)).to have_key("account")
       end
     end
 
     context "when not including root in json" do
 
       before do
-        Mongoid.include_root_in_json = false
+        account.include_root_in_json.should be false
       end
 
       it "uses the mongoid configuration" do
-        expect(person.to_json).to_not include("person")
+        expect(JSON.parse(account.to_json)).not_to have_key("account")
       end
     end
 
+    let(:person) do
+      Person.new
+    end
+
     context "when serializing a relation directly" do
 
       context "when serializing an embeds many" do

data/spec/mongoid/shardable_models.rb

@@ -0,0 +1,75 @@
+class SmMovie
+  include Mongoid::Document
+
+  field :year, type: Integer
+
+  index year: 1
+  shard_key :year
+end
+
+class SmTrailer
+  include Mongoid::Document
+
+  index year: 1
+  shard_key 'year'
+end
+
+class SmActor
+  include Mongoid::Document
+
+  # This is not a usable shard configuration for the server.
+  # We just have it for unit tests.
+  shard_key age: 1, 'gender' => :hashed, 'hello' => :hashed
+end
+
+class SmAssistant
+  include Mongoid::Document
+
+  field :gender, type: String
+
+  index gender: 1
+  shard_key 'gender' => :hashed
+end
+
+class SmProducer
+  include Mongoid::Document
+
+  index age: 1, gender: 1
+  shard_key({age: 1, gender: 'hashed'}, unique: true, numInitialChunks: 2)
+end
+
+class SmDirector
+  include Mongoid::Document
+
+  belongs_to :agency
+
+  index age: 1
+  shard_key :agency
+end
+
+class SmDriver
+  include Mongoid::Document
+
+  belongs_to :agency
+
+  index age: 1, agency: 1
+  shard_key age: 1, agency: :hashed
+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,4 +1,7 @@
+# frozen_string_literal: true
+
 require "spec_helper"
+require_relative './shardable_models'
 
 describe Mongoid::Shardable do
 
@@ -21,70 +24,272 @@ describe Mongoid::Shardable do
 
   describe ".shard_key" do
 
-    let(:klass) do
-      Band
-    end
+    context 'when full syntax is used' do
+      context 'with symbol value' do
+        it 'sets shard key fields to symbol value' do
+          expect(SmProducer.shard_key_fields).to be == %i(age gender)
+        end
 
-    before do
-      Band.shard_key(:name)
-    end
+        it 'sets shard config' do
+          expect(SmProducer.shard_config).to be == {
+            key: {age: 1, gender: 'hashed'},
+            options: {
+              unique: true,
+              numInitialChunks: 2,
+            },
+          }
+        end
 
-    it "specifies a shard key on the collection" do
-      expect(klass.shard_key_fields).to eq([:name])
-    end
+        it 'keeps hashed as string' do
+          expect(SmProducer.shard_config[:key][:gender]).to be == 'hashed'
+        end
+      end
 
-    context 'when a relation is used as the shard key' do
+      context 'with string value' do
+        it 'sets shard key fields to symbol value' do
+          expect(SmActor.shard_key_fields).to be == %i(age gender hello)
+        end
+
+        it 'sets shard config' do
+          expect(SmActor.shard_config).to be == {
+            key: {age: 1, gender: 'hashed', hello: 'hashed'},
+            options: {},
+          }
+        end
 
-      let(:klass) do
-        Game
+        it 'sets hashed to string' do
+          expect(SmActor.shard_config[:key][:gender]).to be == 'hashed'
+        end
       end
 
-      before do
-        Game.shard_key(:person)
+      context 'when passed association name' do
+        it 'uses foreign key as shard key in shard config' do
+          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
+          expect(SmDriver.shard_key_fields).to be == %i(age agency_id)
+        end
       end
+    end
 
-      it "converts the shard key to the foreign key field" do
-        expect(klass.shard_key_fields).to eq([:person_id])
+    context 'when shorthand syntax is used' do
+      context 'with symbol value' do
+        it 'sets shard key fields to symbol value' do
+          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
+          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
+          expect(SmDirector.shard_config).to be == {
+            key: {agency_id: 1},
+            options: {},
+          }
+        end
+
+        it 'uses foreign key as shard key in shard key fields' do
+          expect(SmDirector.shard_key_fields).to be == %i(agency_id)
+        end
       end
     end
   end
 
   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