mongoid 7.2.1 → 9.0.0

data/spec/mongoid/document_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -124,13 +124,13 @@ describe Mongoid::Document do
   describe "._mongoid_clear_types" do
 
     context "when changing the discriminator_value" do
-      
-      before do 
+
+      before do
         Kangaroo._types
         Kangaroo.discriminator_value = "dvalue"
       end
 
-      after do 
+      after do
         Kangaroo.discriminator_value = nil
       end
 
@@ -140,13 +140,13 @@ describe Mongoid::Document do
     end
 
     context "when changing the discriminator_value in child" do
-      
-      before do 
+
+      before do
         Shape._types
         Circle.discriminator_value = "dvalue"
       end
 
-      after do 
+      after do
         Circle.discriminator_value = nil
       end
 
@@ -166,13 +166,28 @@ describe Mongoid::Document do
 
   describe "#attributes" do
 
-    let(:person) do
-      Person.new(title: "Sir")
+    let!(:person) do
+      Person.create!(title: "Sir")
     end
 
     it "returns the attributes with indifferent access" do
       expect(person[:title]).to eq("Sir")
     end
+
+    context "when instantiating a new document" do
+      it "returns a Hash" do
+        expect(person.attributes.class).to eq(Hash)
+      end
+    end
+
+    context "when retrieving a document from the database" do
+
+      let(:from_db) { Person.first }
+
+      it "returns a Hash" do
+        expect(from_db.attributes.class).to eq(Hash)
+      end
+    end
   end
 
   describe "#identity" do
@@ -294,27 +309,6 @@ describe Mongoid::Document do
           expect(person.game.name).to eq("Ms. Pacman")
         end
       end
-
-      context "when instantiating model" do
-
-        let(:person) do
-          Person.instantiate("_id" => BSON::ObjectId.new, "title" => "Sir")
-        end
-
-        before do
-          Person.set_callback :initialize, :after do |doc|
-            doc.title = "Madam"
-          end
-        end
-
-        after do
-          Person.reset_callbacks(:initialize)
-        end
-
-        it "runs the callbacks" do
-          expect(person.title).to eq("Madam")
-        end
-      end
     end
 
     context "when defaults are defined" do
@@ -410,48 +404,12 @@ describe Mongoid::Document do
     end
   end
 
-  describe "#to_a" do
-
-    let(:person) do
-      Person.new
-    end
-
-    let(:people) do
-      person.to_a
-    end
-
-    it "returns the document in an array" do
-      expect(people).to eq([ person ])
-    end
-  end
-
   describe "#as_json" do
 
     let!(:person) do
       Person.new(title: "Sir")
     end
 
-    describe 'id' do
-      context 'rails < 6' do
-        max_rails_version '5.2'
-
-        it 'is a BSON::ObjectId' do
-          id = person.as_json['_id']
-          expect(id).to be_a(BSON::ObjectId)
-        end
-      end
-
-      context 'rails >= 6' do
-        min_rails_version '6.0'
-
-        it 'is a hash with $oid' do
-          id = person.as_json['_id']
-          expect(id).to be_a(Hash)
-          expect(id['$oid']).to be_a(String)
-        end
-      end
-    end
-
     context "when no options are provided" do
 
       it "does not apply any options" do
@@ -471,93 +429,6 @@ describe Mongoid::Document do
         end
       end
     end
-
-    context "when the Mongoid-specific options are provided" do
-
-      let(:options) do
-        { compact: true }
-      end
-
-      it "applies the Mongoid-specific options" do
-        expect(person.as_json(options)["title"]).to eq("Sir")
-        expect(person.as_json(options)["age"]).to eq(100)
-        expect(person.as_json(options).keys).not_to include("lunch_time")
-      end
-
-      context "when options for the super method are provided" do
-
-        let(:options) do
-          { compact: true, only: [:title, :pets, :ssn] }
-        end
-
-        it "passes the options through to the super method" do
-          expect(person.as_json(options)["title"]).to eq("Sir")
-          expect(person.as_json(options)["pets"]).to eq(false)
-        end
-
-        it "applies the Mongoid-specific options" do
-          expect(person.as_json(options).keys).not_to include("ssn")
-        end
-      end
-    end
-
-    context ':compact option' do
-      # Since rails 6 differs in how it treats id fields,
-      # run this test on one version of rails. Currently rails 6 is in beta,
-      # when it is released this version should be changed to 6.
-      max_rails_version '5.2'
-
-      before do
-        # These tests require a specific set of defined attributes
-        # on the model
-        expect(church.as_json.keys.sort).to eq(%w(_id location name))
-      end
-
-      context 'there is a nil valued attribute' do
-        let(:church) do
-          Church.create!(name: 'St. Basil')
-        end
-
-        it 'returns non-nil fields and _id only' do
-          actual = church.as_json(compact: true)
-          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil')
-        end
-      end
-
-      context 'all attrbutes are nil valued' do
-        let(:church) do
-          Church.create!
-        end
-
-        it 'returns a hash with _id only' do
-          actual = church.as_json(compact: true)
-          expect(actual).to eq('_id' => church.id)
-        end
-      end
-
-      context 'there are no nil valued attributes' do
-        let(:church) do
-          Church.create!(name: 'St. Basil', location: {})
-        end
-
-        it 'returns all fields and _id' do
-          actual = church.as_json(compact: true)
-          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil',
-            'location' => {})
-        end
-      end
-
-      context 'when option is specified as a truthy value' do
-        let(:church) do
-          Church.create!(name: 'St. Basil')
-        end
-
-        it 'returns non-nil fields and _id only' do
-          actual = church.as_json(compact: 1)
-          expect(actual).to eq('_id' => church.id, 'name' => 'St. Basil')
-        end
-      end
-    end
   end
 
   describe "#as_document" do
@@ -624,12 +495,12 @@ describe Mongoid::Document do
     context "when removing an embedded document" do
 
       before do
-        person.save
+        person.save!
         person.addresses.delete(address)
       end
 
       it "does not include the document in the hash" do
-        expect(person.as_document["addresses"]).to be_empty
+        expect(person.as_document).to_not have_key("addresses")
       end
     end
 
@@ -637,9 +508,9 @@ describe Mongoid::Document do
 
       before do
         # Save the doc, then set an embeds_one relation to nil
-        person.save
+        person.save!
         person.name = nil
-        person.save
+        person.save!
       end
 
       it "does not include the document in the hash" do
@@ -857,7 +728,7 @@ describe Mongoid::Document do
     end
 
     before do
-      person.save
+      person.save!
     end
 
     it "persists the correct type" do
@@ -924,7 +795,7 @@ describe Mongoid::Document do
       end
 
       context "when no embedded documents are present" do
-        context "when using the default discriminator key" do 
+        context "when using the default discriminator key" do
           let(:person) do
             manager.becomes(Person)
           end
@@ -948,12 +819,12 @@ describe Mongoid::Document do
           end
         end
 
-        context "when using a custom discriminator key" do 
-          before do 
+        context "when using a custom discriminator key" do
+          before do
             Person.discriminator_key = "dkey"
           end
 
-          after do 
+          after do
             Person.discriminator_key = nil
           end
 
@@ -962,13 +833,13 @@ describe Mongoid::Document do
           end
         end
 
-        context "when using a custom discriminator key and discriminator value" do 
-          before do 
+        context "when using a custom discriminator key and discriminator value" do
+          before do
             Person.discriminator_key = "dkey"
             Person.discriminator_value = "dvalue"
           end
 
-          after do 
+          after do
             Person.discriminator_key = nil
             Person.discriminator_value = nil
           end
@@ -1024,11 +895,11 @@ describe Mongoid::Document do
           context "when embedded doc is persisted" do
 
             let(:manager) do
-              Manager.create(title: "Sir")
+              Manager.create!(title: "Sir")
             end
 
             let!(:address) do
-              manager.addresses.create(street: "hobrecht")
+              manager.addresses.create!(street: "hobrecht")
             end
 
             let(:person) do
@@ -1079,7 +950,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          manager.save
+          manager.save!
         end
 
         let(:person) do
@@ -1109,7 +980,7 @@ describe Mongoid::Document do
       context "when the document is dirty" do
 
         before do
-          manager.save
+          manager.save!
           manager.ssn = "123-22-1234"
         end
 
@@ -1207,7 +1078,7 @@ describe Mongoid::Document do
       context "when the document is persisted" do
 
         before do
-          person.save
+          person.save!
         end
 
         let(:manager) do
@@ -1221,7 +1092,7 @@ describe Mongoid::Document do
         context "when downcasted document is saved" do
 
           before do
-            manager.save
+            manager.save!
           end
 
           it "keeps the type" do
@@ -1260,7 +1131,7 @@ describe Mongoid::Document do
       context "when the document is dirty" do
 
         before do
-          person.save
+          person.save!
           person.ssn = "123-22-1234"
         end
 

data/spec/mongoid/equality_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -106,8 +106,8 @@ describe Mongoid::Equality do
 
     context "when comparable is the same class" do
 
-      it "returns true" do
-        expect(klass === Person).to be true
+      it "returns false" do
+        expect(klass === Person).to be false
       end
     end
 
@@ -153,11 +153,10 @@ describe Mongoid::Equality do
     end
 
     context "when comparing to a class" do
-
       context "when the class is the same" do
 
-        it "returns true" do
-          expect(person === Person).to be true
+        it "returns false" do
+          expect(person === Person).to be false
         end
       end
 
@@ -170,8 +169,8 @@ describe Mongoid::Equality do
 
       context "when the class is a superclass" do
 
-        it "returns true" do
-          expect(Doctor.new === Person).to be true
+        it "returns false" do
+          expect(Doctor.new === Person).to be false
         end
       end
     end

data/spec/mongoid/errors/ambiguous_relationship_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require 'spec_helper'
 

data/spec/mongoid/errors/attribute_not_loaded_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+require "spec_helper"
+
+describe Mongoid::Errors::AttributeNotLoaded do
+
+  describe "#message" do
+
+    let(:error) do
+      described_class.new(Band, :label)
+    end
+
+    it "contains the problem in the message" do
+      expect(error.message).to include(
+        "Attempted to access attribute 'label' on Band which was not loaded."
+      )
+    end
+
+    it "contains the summary in the message" do
+      expect(error.message).to include(
+        "You loaded an instance of Band using a query projection method"
+      )
+    end
+
+    it "contains the resolution in the message" do
+      expect(error.message).to include(
+        "Ensure your query projection methods such as `.only` and `.without`"
+      )
+    end
+  end
+end

data/spec/mongoid/errors/callback_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/mongoid/errors/delete_restriction_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -13,7 +13,7 @@ describe Mongoid::Errors::DeleteRestriction do
 
     it "contains the problem in the message" do
       expect(error.message).to include(
-        "Cannot delete Person because of dependent 'drugs'."
+        "Cannot destroy Person because of dependent 'drugs'."
       )
     end
 

data/spec/mongoid/errors/document_not_destroyed_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/mongoid/errors/document_not_found_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -81,6 +81,82 @@ describe Mongoid::Errors::DocumentNotFound do
         )
       end
     end
+
+    context "when providing an _id and a shard key" do
+
+      let(:id) { BSON::ObjectId.new }
+      let(:doc) { { _id: id, a: "syd" } }
+      let(:error) do
+        described_class.new(Person, id, doc)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Document not found for class Person with id #{id.to_s} and shard key a: syd."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "When calling Person.find with an id and a shard key"
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          "Search for an id/shard key that is in the database or set"
+        )
+      end
+    end
+
+    context "when providing an id in a hash without a shard key" do
+
+      let(:error) do
+        described_class.new(Person, 1, { _id: 1 })
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Document(s) not found for class Person with id(s) 1."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "When calling Person.find with an id or array of ids"
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          "Search for an id that is in the database or set the"
+        )
+      end
+    end
+
+    context "when not providing params or unmatched" do
+      let(:error) do
+        described_class.new(Person, nil, nil)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Could not find a document of class Person."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "Mongoid attempted to find a document of the class Person but none exist."
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          "Create a document of class Person or use a finder method that does not raise an exception when no documents are found."
+        )
+      end
+    end
   end
 
   describe "#params" do

data/spec/mongoid/errors/invalid_collection_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/mongoid/errors/{eager_load_spec.rb → invalid_config_file_spec.rb}

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
-describe Mongoid::Errors::EagerLoad do
+describe Mongoid::Errors::InvalidConfigFile do
 
   describe "#message" do
 
     let(:error) do
-      described_class.new(:ratable)
+      described_class.new('/my/path')
     end
 
     it "contains the problem in the message" do
       expect(error.message).to include(
-        "Eager loading :ratable is not supported since it is a polymorphic"
+        "Invalid configuration file: /my/path."
       )
     end
 
     it "contains the summary in the message" do
       expect(error.message).to include(
-        "Mongoid cannot currently determine the classes it needs to eager"
+        "Your mongoid.yml configuration file does not contain the"
       )
     end
 
     it "contains the resolution in the message" do
       expect(error.message).to include(
-        "Don't attempt to perform this action and have patience"
+        "Ensure your configuration file contains the correct contents."
       )
     end
   end

data/spec/mongoid/errors/invalid_config_option_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/mongoid/errors/invalid_field_option_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/mongoid/errors/invalid_field_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
 
@@ -16,7 +16,7 @@ describe Mongoid::Errors::InvalidField do
     end
 
     let(:error) do
-      described_class.new(Person, :crazy_method)
+      described_class.new(Person, :crazy_method, :crazy_method)
     end
 
     it "contains the problem in the message" do