mongoid 6.4.4 → 7.1.7

data/spec/integration/shardable_spec.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+require_relative '../mongoid/shardable_models'
+
+describe 'Sharding helpers' do
+  require_topology :sharded
+
+  describe 'shard_collection rake task' do
+    let(:shard_collections) do
+      Mongoid::Tasks::Database.shard_collections([model_cls])
+    end
+
+    let(:create_indexes) do
+      Mongoid::Tasks::Database.create_indexes([model_cls])
+    end
+
+    shared_examples_for 'shards collection' do
+      it 'returns the model class' do
+        shard_collections.should == [model_cls]
+      end
+
+      it 'shards collection' do
+        shard_collections
+
+        stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+        stats[:sharded].should be true
+      end
+    end
+
+    context 'simple model' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+
+      it 'makes inserts work' do
+        shard_collections
+        create_indexes
+
+        SmMovie.create!(year: 2020)
+      end
+    end
+
+    context 'when database does not exist' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.database.drop
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when database exists but collection does not exist' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        SmMovie.collection.database.drop
+        SmMovie.collection.create
+        SmMovie.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when collection is already sharded' do
+      let(:model_cls) { SmMovie }
+
+      before do
+        Mongoid::Tasks::Database.shard_collections([model_cls])
+      end
+
+      it_behaves_like 'shards collection'
+    end
+
+    context 'when hashed shard key is given' do
+      let(:model_cls) { SmAssistant }
+
+      before do
+        SmAssistant.collection.drop
+      end
+
+      it_behaves_like 'shards collection'
+
+      it 'makes inserts work' do
+        shard_collections
+        create_indexes
+
+        SmAssistant.create!(gender: 'm')
+      end
+    end
+
+    context 'when shard configuration is invalid' do
+      let(:model_cls) { SmActor }
+
+      it 'returns empty array' do
+        shard_collections.should == []
+      end
+
+      it 'does not shards collection' do
+        shard_collections
+
+        stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+        stats[:sharded].should be false
+      end
+
+    end
+
+    context 'when models have no sharded configuration' do
+      let(:model_cls) { SmNotSharded }
+
+      before do
+        model_cls.shard_config.should be nil
+      end
+
+      it 'returns empty array' do
+        shard_collections.should == []
+      end
+
+      context 'pre-4.2' do
+        max_server_version '4.0'
+
+        it 'does not shards collection' do
+          shard_collections
+
+          lambda do
+            model_cls.collection.database.command(collStats: model_cls.collection.name).first
+          end.should raise_error(Mongo::Error::OperationFailure, /Collection.*not found/)
+        end
+      end
+
+      context '4.2+' do
+        min_server_version '4.2'
+
+        it 'does not shards collection' do
+          shard_collections
+
+          stats = model_cls.collection.database.command(collStats: model_cls.collection.name).first
+          stats[:sharded].should be false
+        end
+      end
+    end
+  end
+end

data/spec/lite_spec_helper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+# Load byebug before mongoid, to place breakpoints in the lib methods.
+# But SpecConfig needs the driver code - require the driver here.
+require "mongo"
+
+# MRI 2.5 and JRuby 9.2 change visibility of Object#pp when 'pp' is required,
+# which happens when RSpec reports anything. This creates an issue for tests
+# that verify method forwarding. Work around by proactively loading 'pp'.
+# https://github.com/jruby/jruby/issues/5599
+require 'pp'
+
+require 'support/spec_config'
+require 'support/lite_constraints'
+require "support/session_registry"
+
+unless SpecConfig.instance.ci?
+  begin
+    require 'byebug'
+  rescue LoadError
+    # jruby - try pry
+    begin
+      require 'pry'
+    # jruby likes to raise random error classes, in this case
+    # NameError in addition to LoadError
+    rescue Exception
+    end
+  end
+end
+
+require 'mongoid'
+
+if SpecConfig.instance.mri?
+  require 'timeout_interrupt'
+else
+  require 'timeout'
+  TimeoutInterrupt = Timeout
+end
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  if SpecConfig.instance.ci?
+    config.add_formatter(RSpec::Core::Formatters::JsonFormatter, File.join(File.dirname(__FILE__), '../tmp/rspec.json'))
+  end
+
+  if SpecConfig.instance.ci? && !%w(1 true yes).include?(ENV['INTERACTIVE']&.downcase)
+    timeout = if SpecConfig.instance.app_tests?
+      # Allow 5 minutes per test for the app tests, since they install
+      # gems for Rails applications which can take a long time.
+      300
+    else
+      # Allow a max of 30 seconds per test.
+      # Tests should take under 10 seconds ideally but it seems
+      # we have some that run for more than 10 seconds in CI.
+      30
+    end
+    config.around(:each) do |example|
+      TimeoutInterrupt.timeout(timeout) do
+        example.run
+      end
+    end
+  end
+
+  config.extend(LiteConstraints)
+end
+
+# require all shared examples
+Dir['./spec/support/shared/*.rb'].sort.each { |file| require file }

data/spec/mongoid/{relations → association}/accessors_spec.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require "spec_helper"
 
-describe Mongoid::Relations::Accessors do
+describe Mongoid::Association::Accessors do
 
   describe "\#{getter}?" do
 
@@ -8,9 +11,9 @@ describe Mongoid::Relations::Accessors do
       Person.create
     end
 
-    context "when the relation is a has one" do
+    context "when the association is a has one" do
 
-      context "when the relation exists" do
+      context "when the association exists" do
 
         let!(:game) do
           person.build_game
@@ -21,7 +24,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not exist" do
+      context "when the association does not exist" do
 
         context "when not autobuilding" do
 
@@ -39,9 +42,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is a has many" do
+    context "when the association is a has many" do
 
-      context "when the relation has documents" do
+      context "when the association has documents" do
 
         let!(:post) do
           person.posts.build
@@ -52,7 +55,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not have documents" do
+      context "when the association does not have documents" do
 
         it "returns false" do
           expect(person).to_not have_posts
@@ -60,9 +63,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is a has and belongs to many" do
+    context "when the association is a has and belongs to many" do
 
-      context "when the relation has documents" do
+      context "when the association has documents" do
 
         let!(:preference) do
           person.preferences.build
@@ -73,7 +76,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not have documents" do
+      context "when the association does not have documents" do
 
         it "returns false" do
           expect(person).to_not have_preferences
@@ -81,9 +84,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is a belongs to" do
+    context "when the association is a belongs to" do
 
-      context "when the relation is named next" do
+      context "when the association is named next" do
 
         let(:user) do
           User.create
@@ -94,7 +97,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation exists" do
+      context "when the association exists" do
 
         let!(:game) do
           person.build_game
@@ -105,9 +108,9 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not exist" do
+      context "when the association does not exist" do
 
-        context "when the relation does not autobuild" do
+        context "when the association does not autobuild" do
 
           let(:game) do
             Game.new
@@ -118,7 +121,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation autobuilds" do
+        context "when the association autobuilds" do
 
           let(:book) do
             Book.new
@@ -131,9 +134,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is an embeds one" do
+    context "when the association is an embeds one" do
 
-      context "when the relation exists" do
+      context "when the association exists" do
 
         let!(:name) do
           person.build_name
@@ -144,16 +147,16 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not exist" do
+      context "when the association does not exist" do
 
-        context "when the relation does not autobuild" do
+        context "when the association does not autobuild" do
 
           it "returns false" do
             expect(person).to_not have_name
           end
         end
 
-        context "when the relation autobuilds" do
+        context "when the association autobuilds" do
 
           let(:person) do
             Person.new
@@ -166,9 +169,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is an embeds many" do
+    context "when the association is an embeds many" do
 
-      context "when the relation has documents" do
+      context "when the association has documents" do
 
         let!(:address) do
           person.addresses.build
@@ -179,7 +182,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not have documents" do
+      context "when the association does not have documents" do
 
         it "returns false" do
           expect(person).to_not have_addresses
@@ -187,9 +190,9 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is an embedded in" do
+    context "when the association is an embedded in" do
 
-      context "when the relation exists" do
+      context "when the association exists" do
 
         let!(:name) do
           person.build_name
@@ -200,9 +203,9 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation does not exist" do
+      context "when the association does not exist" do
 
-        context "when the relation does not autobuild" do
+        context "when the association does not autobuild" do
 
           let(:name) do
             Name.new
@@ -213,7 +216,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation autobuilds" do
+        context "when the association autobuilds" do
 
           let(:passport) do
             Passport.new
@@ -233,11 +236,11 @@ describe Mongoid::Relations::Accessors do
       Person.new
     end
 
-    context "when autobuilding the relation" do
+    context "when autobuilding the association" do
 
-      context "when the relation is an embeds one" do
+      context "when the association is an embeds one" do
 
-        context "when the relation does not exist" do
+        context "when the association does not exist" do
 
           let!(:passport) do
             person.passport
@@ -252,7 +255,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation exists" do
+        context "when the association exists" do
 
           let!(:passport) do
             person.build_passport(number: "123123321")
@@ -261,16 +264,17 @@ describe Mongoid::Relations::Accessors do
           it "does not build a new document" do
             expect(person.passport).to eq(passport)
           end
+
         end
       end
 
-      context "when the relation is an embedded in" do
+      context "when the association is an embedded in" do
 
         let(:passport) do
           Passport.new
         end
 
-        context "when the relation does not exist" do
+        context "when the association does not exist" do
 
           let(:person) do
             passport.person
@@ -281,7 +285,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation exists" do
+        context "when the association exists" do
 
           let!(:person) do
             passport.build_person(title: "sir")
@@ -293,9 +297,9 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation is a has one" do
+      context "when the association is a has one" do
 
-        context "when the relation does not exist" do
+        context "when the association does not exist" do
 
           let(:book) do
             person.book
@@ -306,7 +310,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation exists" do
+        context "when the association exists" do
 
           let!(:book) do
             person.build_book(title: "art of war")
@@ -318,13 +322,13 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation is a belongs to" do
+      context "when the association is a belongs to" do
 
         let(:book) do
           Book.new
         end
 
-        context "when the relation does not exist" do
+        context "when the association does not exist" do
 
           let(:person) do
             book.person
@@ -335,7 +339,7 @@ describe Mongoid::Relations::Accessors do
           end
         end
 
-        context "when the relation exists" do
+        context "when the association exists" do
 
           let!(:person) do
             book.build_person(title: "sir")
@@ -348,13 +352,13 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is not polymorphic" do
+    context "when the association is not polymorphic" do
 
       let(:person) do
         Person.create
       end
 
-      context "when the relation is a many to many" do
+      context "when the association is a many to many" do
 
         let!(:preference) do
           Preference.create(name: "Setting")
@@ -364,7 +368,7 @@ describe Mongoid::Relations::Accessors do
           person.preferences << Preference.last
         end
 
-        context "when reloading the relation directly" do
+        context "when reloading the association directly" do
 
           let(:preferences) do
             person.preferences(true)
@@ -406,7 +410,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation is a many to one" do
+      context "when the association is a many to one" do
 
         let!(:post) do
           Post.create(title: "First!")
@@ -416,7 +420,7 @@ describe Mongoid::Relations::Accessors do
           person.posts << Post.last
         end
 
-        context "when reloading the relation directly" do
+        context "when reloading the association directly" do
 
           let(:posts) do
             person.posts(true)
@@ -458,7 +462,7 @@ describe Mongoid::Relations::Accessors do
         end
       end
 
-      context "when the relation is a references one" do
+      context "when the association is a references one" do
 
         let!(:game) do
           Game.create(name: "Centipeded")
@@ -468,7 +472,7 @@ describe Mongoid::Relations::Accessors do
           person.game = Game.last
         end
 
-        context "when reloading the relation directly" do
+        context "when reloading the association directly" do
 
           let(:reloaded_game) do
             person.game(true)
@@ -511,7 +515,7 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when the relation is polymorphic" do
+    context "when the association is polymorphic" do
 
       context "when there's a single references many/one" do
 
@@ -565,9 +569,183 @@ describe Mongoid::Relations::Accessors do
         end
       end
     end
+
+    context 'when projecting' do
+      context 'embeds_one' do
+
+        let!(:person) do
+          Person.create!(passport: Passport.new(number: "123123321", country: "USA"))
+        end
+
+        context "when the record is queried with the embedded association projected" do
+          let(:persisted_person) { Person.only(:passport).first }
+
+          it 'creates an accessor for the projected embedded document' do
+            expect(persisted_person.passport.number).to eq("123123321")
+            expect(persisted_person.passport.country).to eq("USA")
+          end
+        end
+
+        context 'when the record is queried with a field on the embedded association projected' do
+          let(:persisted_person) { Person.only("pass.number").first }
+
+          it 'creates an accessor for the projected field on the embedded document' do
+            expect(persisted_person.passport.number).to eq("123123321")
+          end
+
+          it 'does not create an accessor for another field on the embedded document' do
+            expect do
+              persisted_person.passport.country
+            end.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context 'when projecting association and a field in association' do
+          shared_examples 'is prohibited on 4.4+ server' do
+            context '4.4 server and higher' do
+              min_server_version '4.4'
+
+              it 'is not allowed by server' do
+                lambda do
+                  persisted_person
+                end.should raise_error(Mongo::Error::OperationFailure, /Path collision at pass/)
+              end
+            end
+          end
+
+          context 'association then field' do
+            let(:persisted_person) { Person.only(:pass, "pass.number").first }
+
+            context '4.2 server and lower' do
+              max_server_version '4.2'
+
+              it 'creates an accessor for the projected field on the embedded document' do
+                expect(persisted_person.passport.number).to eq("123123321")
+              end
+
+              it 'does not create an accessor for another field on the embedded document' do
+                expect do
+                  persisted_person.passport.country
+                end.to raise_error(ActiveModel::MissingAttributeError)
+              end
+            end
+
+            include_examples 'is prohibited on 4.4+ server'
+          end
+
+          context 'field then association' do
+            let(:persisted_person) { Person.only('pass.number', :pass).first }
+
+            context '4.2 server and lower' do
+              max_server_version '4.2'
+
+              it 'creates an accessor for the projected field on the embedded document' do
+                expect(persisted_person.passport.number).to eq("123123321")
+              end
+
+              it 'retrieves other fields' do
+                persisted_person.passport.country.should == 'USA'
+              end
+            end
+
+            include_examples 'is prohibited on 4.4+ server'
+          end
+        end
+      end
+
+      context 'embeds_many' do
+
+        let!(:person) do
+          Person.create!(phone_numbers: [
+            Phone.new(number: '111-111-1111', landline: true),
+          ])
+        end
+
+        context 'when the record is queried with the embedded association projected' do
+          let(:persisted_person) { Person.only(:phone_numbers).first }
+
+          it 'creates an accessor for the embedded document' do
+            expect(persisted_person.phone_numbers.first.number).to eq('111-111-1111')
+            expect(persisted_person.phone_numbers.first.landline).to be true
+          end
+        end
+
+        shared_examples 'allows access to field of projected association' do
+          it 'creates an accessor for the embedded document' do
+            expect(persisted_person.phone_numbers.first).to be_a_kind_of(Phone)
+          end
+
+          it 'creates an accessor for the projected field on the embedded document' do
+            expect(persisted_person.phone_numbers.first.number).to eq('111-111-1111')
+          end
+        end
+
+        context 'when the record is queried with a field on the embedded association projected' do
+          let(:persisted_person) { Person.only("phone_numbers.number").first }
+
+          include_examples 'allows access to field of projected association'
+
+          it 'does not create an accessor for another field on the embedded document' do
+            expect do
+              persisted_person.phone_numbers.first.landline
+            end.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context 'when projecting association and a field in association' do
+
+          shared_examples 'is prohibited on 4.4+ server' do
+            context '4.4 server and higher' do
+              min_server_version '4.4'
+
+              it 'is not allowed by server' do
+                lambda do
+                  persisted_person
+                end.should raise_error(Mongo::Error::OperationFailure, /Path collision at phone_numbers/)
+              end
+            end
+          end
+
+          context 'association then field' do
+            let(:persisted_person) { Person.only(:phone_numbers, 'phone_numbers.number').first }
+
+            context '4.2 server and lower' do
+              max_server_version '4.2'
+
+              include_examples 'allows access to field of projected association'
+
+              it 'does not create an accessor for another field on the embedded document' do
+                expect do
+                  persisted_person.phone_numbers.first.landline
+                end.to raise_error(ActiveModel::MissingAttributeError)
+              end
+
+            end
+
+            include_examples 'is prohibited on 4.4+ server'
+          end
+
+          context 'field then association' do
+            let(:persisted_person) { Person.only('phone_numbers.number', :phone_numbers).first }
+
+            context '4.2 server and lower' do
+              max_server_version '4.2'
+
+              include_examples 'allows access to field of projected association'
+
+              it 'retrieves all fields of association' do
+                persisted_person.phone_numbers.first.landline.should be true
+              end
+            end
+
+            include_examples 'is prohibited on 4.4+ server'
+          end
+        end
+      end
+    end
   end
 
-  context "when setting relations to empty values" do
+  context "when setting associations to empty values" do
 
     context "when the document is a referenced in" do
 
@@ -575,7 +753,7 @@ describe Mongoid::Relations::Accessors do
         Post.new
       end
 
-      context "when setting the relation directly" do
+      context "when setting the association directly" do
 
         before do
           post.person = ""
@@ -604,7 +782,7 @@ describe Mongoid::Relations::Accessors do
         Person.new
       end
 
-      context "when setting the relation directly" do
+      context "when setting the association directly" do
 
         before do
           person.game = ""
@@ -687,6 +865,45 @@ describe Mongoid::Relations::Accessors do
     end
   end
 
+  context 'when setting associations to nil values' do
+    context 'when the document embeds one' do
+      let(:definitions) do
+        class AccessorEmbedding
+          include Mongoid::Document
+
+          embeds_one :accessor_embedded
+        end
+
+        class AccessorEmbedded
+          include Mongoid::Document
+
+          embedded_in :accessor_embedding
+        end
+
+        define_embedded
+      end
+
+      let(:embedding) do
+        AccessorEmbedding.create!
+      end
+
+      let(:define_embedded) do
+        AccessorEmbedded.create!(accessor_embedding: embedding)
+      end
+
+      it 'successfully removes the embedded document' do
+        definitions
+
+        expect(embedding.accessor_embedded).not_to be_nil
+
+        embedding.accessor_embedded = nil
+        embedding.save!
+
+        expect(embedding.reload.accessor_embedded).to be_nil
+      end
+    end
+  end
+
   context "when setting association foreign keys" do
 
     let(:game) do
@@ -701,7 +918,7 @@ describe Mongoid::Relations::Accessors do
 
       before do
         game.person_id = ""
-        game.save
+        game.save!
       end
 
       it "sets the foreign key to empty" do
@@ -713,7 +930,7 @@ describe Mongoid::Relations::Accessors do
 
       before do
         game.person_id = person.id.to_s
-        game.save
+        game.save!
       end
 
       it "sets the foreign key as ObjectID" do
@@ -725,7 +942,7 @@ describe Mongoid::Relations::Accessors do
 
       before do
         game.person_id = person.id
-        game.save
+        game.save!
       end
 
       it "keeps the foreign key as ObjectID" do
@@ -733,30 +950,30 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context "when setting ids multiple times on the relation itself" do
+    context "when setting ids multiple times on the association itself" do
 
       before do
         game.person = person.id
         game.person = person.id
       end
 
-      it "sets the relation foreign key" do
+      it "sets the association foreign key" do
         expect(game.person_id).to eq(person.id)
       end
 
-      it "sets the appropriate relation" do
+      it "sets the appropriate association" do
         expect(game.person).to eq(person)
       end
     end
   end
 
-  context 'when setting the relation more than once' do
+  context 'when setting the association more than once' do
 
     let(:person) do
       Person.create
     end
 
-    context 'when the relation is a references one' do
+    context 'when the association is a references one' do
 
       let(:game) do
         Game.create
@@ -772,7 +989,7 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context 'when the relation is a references many' do
+    context 'when the association is a references many' do
 
       let!(:preference) do
         Preference.create(name: "Setting")
@@ -787,7 +1004,7 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context 'when the relation is an embeds one' do
+    context 'when the association is an embeds one' do
 
       let!(:name) do
         Name.new
@@ -803,7 +1020,7 @@ describe Mongoid::Relations::Accessors do
       end
     end
 
-    context 'when the relation is an embeds many' do
+    context 'when the association is an embeds many' do
 
       let!(:address) do
         Address.new