mongoid 7.1.1 → 8.1.0

data/spec/mongoid/findable_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 
@@ -8,8 +7,8 @@ describe Mongoid::Findable do
   describe ".distinct" do
 
     before do
-      Band.create(name: "Tool")
-      Band.create(name: "Photek")
+      Band.create!(name: "Tool")
+      Band.create!(name: "Photek")
     end
 
     it "returns the distinct values for the field" do
@@ -20,7 +19,7 @@ describe Mongoid::Findable do
   describe ".each" do
 
     let!(:band) do
-      Band.create
+      Band.create!
     end
 
     it "iterates through all documents" do
@@ -33,7 +32,7 @@ describe Mongoid::Findable do
   describe ".each_with_index" do
 
     let!(:band) do
-      Band.create
+      Band.create!
     end
 
     it "iterates through all documents" do
@@ -46,7 +45,7 @@ describe Mongoid::Findable do
   describe ".find_one_and_update" do
 
     let!(:person) do
-      Person.create(title: "Senior")
+      Person.create!(title: "Senior")
     end
 
     it "returns the document" do
@@ -59,7 +58,7 @@ describe Mongoid::Findable do
     context "when collection is a embeds_many" do
 
       let(:person) do
-        Person.create(title: "sir")
+        Person.create!(title: "sir")
       end
 
       let!(:message) do
@@ -76,27 +75,17 @@ describe Mongoid::Findable do
       context "when the document is not found" do
 
         context "when raising a not found error" do
-
-          let!(:raise_option) { Mongoid.raise_not_found_error }
-
-          before { Mongoid.raise_not_found_error = true }
-
-          after { Mongoid.raise_not_found_error = raise_option }
+          config_override :raise_not_found_error, true
 
           it "raises an error" do
             expect {
               person.messages.find_by(body: 'bar')
-            }.to raise_error(Mongoid::Errors::DocumentNotFound)
+            }.to raise_error(Mongoid::Errors::DocumentNotFound, /Document not found for class Message with attributes/)
           end
         end
 
         context "when raising no error" do
-
-          let!(:raise_option) { Mongoid.raise_not_found_error }
-
-          before { Mongoid.raise_not_found_error = false }
-
-          after { Mongoid.raise_not_found_error = raise_option }
+          config_override :raise_not_found_error, false
 
           it "returns nil" do
             expect(person.messages.find_by(body: 'bar')).to be_nil
@@ -108,7 +97,7 @@ describe Mongoid::Findable do
     context "when the document is found" do
 
       let!(:person) do
-        Person.create(title: "sir")
+        Person.create!(title: "sir")
       end
 
       context "when no block is provided" do
@@ -135,27 +124,17 @@ describe Mongoid::Findable do
     context "when the document is not found" do
 
       context "when raising a not found error" do
-
-        let!(:raise_option) { Mongoid.raise_not_found_error }
-
-        before { Mongoid.raise_not_found_error = true }
-
-        after { Mongoid.raise_not_found_error = raise_option }
+        config_override :raise_not_found_error, true
 
         it "raises an error" do
           expect {
             Person.find_by(ssn: "333-22-1111")
-          }.to raise_error(Mongoid::Errors::DocumentNotFound)
+          }.to raise_error(Mongoid::Errors::DocumentNotFound, /Document not found for class Person with attributes/)
         end
       end
 
       context "when raising no error" do
-
-        let!(:raise_option) { Mongoid.raise_not_found_error }
-
-        before { Mongoid.raise_not_found_error = false }
-
-        after { Mongoid.raise_not_found_error = raise_option }
+        config_override :raise_not_found_error, false
 
         context "when no block is provided" do
 
@@ -185,7 +164,7 @@ describe Mongoid::Findable do
     context "when the document is found" do
 
       let!(:person) do
-        Person.create(title: "sir")
+        Person.create!(title: "sir")
       end
 
       context "when no block is provided" do
@@ -214,7 +193,7 @@ describe Mongoid::Findable do
       it "raises an error" do
         expect {
           Person.find_by!(ssn: "333-22-1111")
-        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+        }.to raise_error(Mongoid::Errors::DocumentNotFound, /Document not found for class Person with attributes/)
       end
     end
   end
@@ -223,13 +202,411 @@ describe Mongoid::Findable do
 
     describe "##{method}" do
 
-      let!(:person) do
-        Person.create
+      let!(:person1) do
+        Person.create!
+      end
+
+      let!(:person2) do
+        Person.create!
       end
 
       it "returns the first matching document" do
-        expect(Person.send(method)).to eq(person)
+        expect(Person.send(method)).to eq(person1)
       end
+
+      it "passes the limit through" do
+        expect(Person.send(method, 1)).to eq([ person1 ])
+      end
+
+      it "returns nil when no documents are found" do
+        expect(Band.send(method)).to be_nil
+      end
+    end
+  end
+
+  describe "#first!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    it "returns the first matching document" do
+      expect(Person.first!).to eq(person1)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.first!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#last" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    it "returns the first matching document" do
+      expect(Person.last).to eq(person2)
+    end
+
+    it "passes the limit through" do
+      expect(Person.last(1)).to eq([ person2 ])
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.last).to be_nil
+    end
+  end
+
+  describe "#last!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    it "returns the last matching document" do
+      expect(Person.last!).to eq(person2)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.last!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#second" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    it "returns the second matching document" do
+      expect(Person.second).to eq(person2)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.second).to be_nil
+    end
+  end
+
+  describe "#second!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    it "returns the second matching document" do
+      expect(Person.second!).to eq(person2)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.second!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#third" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    it "returns the third matching document" do
+      expect(Person.third).to eq(person3)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.third).to be_nil
+    end
+  end
+
+  describe "#third!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    it "returns the third matching document" do
+      expect(Person.third!).to eq(person3)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.third!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#fourth" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    it "returns the fourth matching document" do
+      expect(Person.fourth).to eq(person4)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.fourth).to be_nil
+    end
+  end
+
+  describe "#fourth!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    it "returns the fourth matching document" do
+      expect(Person.fourth!).to eq(person4)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.fourth!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#fifth" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the fifth matching document" do
+      expect(Person.fifth).to eq(person5)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.fifth).to be_nil
+    end
+  end
+
+  describe "#fifth!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the fifth matching document" do
+      expect(Person.fifth!).to eq(person5)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.fifth!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#second_to_last" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the second to last matching document" do
+      expect(Person.second_to_last).to eq(person4)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.second_to_last).to be_nil
+    end
+  end
+
+  describe "#second_to_last!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the second to last matching document" do
+      expect(Person.second_to_last!).to eq(person4)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.second_to_last!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
+    end
+  end
+
+  describe "#third_to_last" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the third to last matching document" do
+      expect(Person.third_to_last).to eq(person3)
+    end
+
+    it "returns nil when no documents are found" do
+      expect(Band.third_to_last).to be_nil
+    end
+  end
+
+  describe "#third_to_last!" do
+    let!(:person1) do
+      Person.create!
+    end
+
+    let!(:person2) do
+      Person.create!
+    end
+
+    let!(:person3) do
+      Person.create!
+    end
+
+    let!(:person4) do
+      Person.create!
+    end
+
+    let!(:person5) do
+      Person.create!
+    end
+
+    it "returns the third to last matching document" do
+      expect(Person.third_to_last!).to eq(person3)
+    end
+
+    it "raises an error when there are no documents" do
+      expect do
+        Band.third_to_last!
+      end.to raise_error(Mongoid::Errors::DocumentNotFound, /Could not find a document of class Band./)
     end
   end
 
@@ -238,7 +615,7 @@ describe Mongoid::Findable do
     context "when the document is found" do
 
       let!(:person) do
-        Person.create
+        Person.create!
       end
 
       it "returns the document" do
@@ -251,7 +628,7 @@ describe Mongoid::Findable do
       context "when providing a document" do
 
         let!(:person) do
-          Person.create
+          Person.create!
         end
 
         let(:from_db) do
@@ -306,7 +683,7 @@ describe Mongoid::Findable do
     context "when the document is found" do
 
       let!(:person) do
-        Person.create
+        Person.create!
       end
 
       it "returns the document" do
@@ -319,7 +696,7 @@ describe Mongoid::Findable do
       context "when providing a document" do
 
         let!(:person) do
-          Person.create
+          Person.create!
         end
 
         let(:found) do
@@ -380,7 +757,7 @@ describe Mongoid::Findable do
   describe ".none" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode", likes: 3)
+      Band.create!(name: "Depeche Mode", likes: 3)
     end
 
     context "when not chaining any criteria" do
@@ -445,15 +822,15 @@ describe Mongoid::Findable do
   describe ".pluck" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode", likes: 3)
+      Band.create!(name: "Depeche Mode", likes: 3)
     end
 
     let!(:tool) do
-      Band.create(name: "Tool", likes: 3)
+      Band.create!(name: "Tool", likes: 3)
     end
 
     let!(:photek) do
-      Band.create(name: "Photek", likes: 1)
+      Band.create!(name: "Photek", likes: 1)
     end
 
     context "when field values exist" do
@@ -473,12 +850,44 @@ describe Mongoid::Findable do
         Band.pluck(:follows)
       end
 
-      it "returns a array with nil values" do
+      it "returns an array with nil values" do
         expect(plucked).to eq([nil, nil, nil])
       end
     end
   end
 
+  describe '.count' do
+    context 'when the collection is not empty' do
+      before do
+        Band.create!(name: "Tool")
+        Band.create!(name: "Photek")
+      end
+
+      it 'returns the currect count' do
+        expect(Band.count).to eq(2)
+      end
+    end
+  end
+
+  describe '.estimated_count' do
+    context 'when the collection is not empty' do
+      before do
+        Band.create!(name: "Tool")
+        Band.create!(name: "Photek")
+      end
+
+      it 'returns the correct count' do
+        expect(Band.estimated_count).to eq(2)
+      end
+    end
+
+    context 'when the collection is empty' do
+      it 'returns the correct count' do
+        expect(Band.estimated_count).to eq(0)
+      end
+    end
+  end
+
   Mongoid::Criteria::Queryable::Selectable.forwardables.each do |method|
 
     describe "##{method}" do
@@ -490,21 +899,43 @@ describe Mongoid::Findable do
   end
 
   context 'when Mongoid is configured to use activesupport time zone' do
-
-    before do
-      Mongoid.use_utc = false
-      Mongoid.use_activesupport_time_zone = true
-      Time.zone = "Asia/Kolkata"
-    end
+    config_override :use_utc, false
+    config_override :use_activesupport_time_zone, true
+    time_zone_override "Asia/Kolkata"
 
     let!(:time) do
       Time.zone.now.tap do |t|
-        User.create(last_login: t, name: 'Tom')
+        User.create!(last_login: t, name: 'Tom')
       end
     end
 
-    it 'uses activesupport time zone' do
-      expect(User.distinct(:last_login).first.to_s).to eql(time.in_time_zone('Asia/Kolkata').to_s)
+    context 'when distinct does not demongoize' do
+      config_override :legacy_pluck_distinct, true
+
+      let(:distinct) do
+        User.distinct(:last_login).first
+      end
+
+      it 'uses activesupport time zone' do
+        distinct.should be_a(ActiveSupport::TimeWithZone)
+        expect(distinct.to_s).to eql(time.in_time_zone('Asia/Kolkata').to_s)
+      end
+    end
+
+    context 'when distinct demongoizes' do
+      config_override :legacy_pluck_distinct, false
+
+      let(:distinct) do
+        User.distinct(:last_login).first
+      end
+
+      it 'uses activesupport time zone' do
+        distinct.should be_a(DateTime)
+        # Time and DateTime have different stringifications:
+        # 2022-03-16T21:12:32+00:00
+        # 2022-03-16 21:12:32 UTC
+        expect(distinct.to_s).to eql(time.in_time_zone('Asia/Kolkata').to_datetime.to_s)
+      end
     end
 
     it 'loads other fields accurately' do
@@ -513,20 +944,42 @@ describe Mongoid::Findable do
   end
 
   context 'when Mongoid is not configured to use activesupport time zone' do
-
-    before do
-      Mongoid.use_utc = true
-      Mongoid.use_activesupport_time_zone = false
-    end
+    config_override :use_utc, true
+    config_override :use_activesupport_time_zone, false
 
     let!(:time) do
       Time.now.tap do |t|
-        User.create(last_login: t, name: 'Tom')
+        User.create!(last_login: t, name: 'Tom')
       end
     end
 
-    it 'uses utc' do
-      expect(User.distinct(:last_login).first.to_s).to eql(time.utc.to_s)
+    context 'when distinct does not demongoize' do
+      config_override :legacy_pluck_distinct, true
+
+      let(:distinct) do
+        User.distinct(:last_login).first
+      end
+
+      it 'uses utc' do
+        distinct.should be_a(Time)
+        expect(distinct.to_s).to eql(time.utc.to_s)
+      end
+    end
+
+    context 'when distinct demongoizes' do
+      config_override :legacy_pluck_distinct, false
+
+      let(:distinct) do
+        User.distinct(:last_login).first
+      end
+
+      it 'uses utc' do
+        distinct.should be_a(DateTime)
+        # Time and DateTime have different stringifications:
+        # 2022-03-16T21:12:32+00:00
+        # 2022-03-16 21:12:32 UTC
+        expect(distinct.to_s).to eql(time.utc.to_datetime.to_s)
+      end
     end
 
     it 'loads other fields accurately' do