mongoid 7.0.10 → 7.4.0

data/spec/mongoid/contextual/mongo_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Contextual::Mongo do
@@ -7,7 +9,7 @@ describe Mongoid::Contextual::Mongo do
     describe "##{method}" do
 
       before do
-        Band.create(name: "Depeche Mode")
+        Band.create!(name: "Depeche Mode")
       end
 
       context "when the count is zero" do
@@ -78,11 +80,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#count" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -106,11 +108,8 @@ describe Mongoid::Contextual::Mongo do
         described_class.new(criteria.cache)
       end
 
-      before do
-        expect(context.view).to receive(:count).once.and_return(1)
-      end
-
       it "returns the count cached value after first call" do
+        expect(context.view).to receive(:count_documents).once.and_return(1)
         2.times { expect(context.count).to eq(1) }
       end
     end
@@ -134,7 +133,7 @@ describe Mongoid::Contextual::Mongo do
       context "and a limit true" do
 
         before do
-          2.times { Band.create(name: "Depeche Mode", likes: 1) }
+          2.times { Band.create!(name: "Depeche Mode", likes: 1) }
         end
 
         let(:count) do
@@ -152,7 +151,7 @@ describe Mongoid::Contextual::Mongo do
     context "when provided limit" do
 
       before do
-        2.times { Band.create(name: "Depeche Mode") }
+        2.times { Band.create!(name: "Depeche Mode") }
       end
 
       let(:context) do
@@ -192,16 +191,81 @@ describe Mongoid::Contextual::Mongo do
     end
   end
 
+  describe "#estimated_count" do
+
+    let!(:depeche) do
+      Band.create!(name: "Depeche Mode")
+    end
+
+    let!(:new_order) do
+      Band.create!(name: "New Order")
+    end
+
+    let(:criteria) do
+      Band.where
+    end
+
+    context "when not providing options" do
+      it 'returns the correct count' do
+        expect(criteria.estimated_count).to eq(2)
+      end
+    end
+
+    context "when providing options" do
+      it 'returns the correct count' do
+        expect(criteria.estimated_count(maxTimeMS: 1000)).to eq(2)
+      end
+    end
+
+    context "when context is cached" do
+
+      let(:context) do
+        described_class.new(criteria.cache)
+      end
+
+      it "returns the count cached value after first call" do
+        expect(context.view).to receive(:estimated_document_count).once.and_return(1)
+        2.times do
+          context.estimated_count
+        end
+      end
+    end
+
+    context "when the criteria contains a selector", :focus do
+      let(:criteria) do
+        Band.where(name: "New Order")
+      end
+
+      context "when not providing options" do
+        it 'raises an error' do
+          expect do
+            criteria.estimated_count
+          end.to raise_error(Mongoid::Errors::InvalidEstimatedCountCriteria)
+        end
+      end
+
+      context "when providing options" do
+        it 'raises an error' do
+          expect do
+            criteria.estimated_count(maxTimeMS: 1000)
+          end.to raise_error(Mongoid::Errors::InvalidEstimatedCountCriteria)
+        end
+      end
+    end
+  end
+
+
+
   [ :delete, :delete_all ].each do |method|
 
     describe "##{method}" do
 
       let!(:depeche_mode) do
-        Band.create(name: "Depeche Mode")
+        Band.create!(name: "Depeche Mode")
       end
 
       let!(:new_order) do
-        Band.create(name: "New Order")
+        Band.create!(name: "New Order")
       end
 
       context "when the selector is contraining" do
@@ -302,11 +366,11 @@ describe Mongoid::Contextual::Mongo do
     describe "##{method}" do
 
       let!(:depeche_mode) do
-        Band.create(name: "Depeche Mode")
+        Band.create!(name: "Depeche Mode")
       end
 
       let!(:new_order) do
-        Band.create(name: "New Order")
+        Band.create!(name: "New Order")
       end
 
       context "when the selector is contraining" do
@@ -387,7 +451,7 @@ describe Mongoid::Contextual::Mongo do
     context 'when the write concern is unacknowledged' do
 
       before do
-        2.times { Band.create }
+        2.times { Band.create! }
       end
 
       let(:criteria) do
@@ -409,27 +473,83 @@ describe Mongoid::Contextual::Mongo do
   describe "#distinct" do
 
     before do
-      Band.create(name: "Depeche Mode", years: 30)
-      Band.create(name: "New Order", years: 25)
+      Band.create!(name: "Depeche Mode", years: 30, sales: "1E2")
+      Band.create!(name: "New Order", years: 25, sales: "2E3")
+      Band.create!(name: "10,000 Maniacs", years: 20, sales: "1E2")
     end
 
-    context "when limiting the result set" do
+    with_config_values :legacy_pluck_distinct, true, false do
+      context "when limiting the result set" do
 
-      let(:criteria) do
-        Band.where(name: "Depeche Mode")
+        let(:criteria) do
+          Band.where(name: "Depeche Mode")
+        end
+
+        let(:context) do
+          described_class.new(criteria)
+        end
+
+        it "returns the distinct matching fields" do
+          expect(context.distinct(:name)).to eq([ "Depeche Mode" ])
+        end
       end
 
-      let(:context) do
-        described_class.new(criteria)
+      context "when not limiting the result set" do
+
+        let(:criteria) do
+          Band.criteria
+        end
+
+        let(:context) do
+          described_class.new(criteria)
+        end
+
+        it "returns the distinct field values" do
+          expect(context.distinct(:name).sort).to eq([ "10,000 Maniacs", "Depeche Mode", "New Order" ].sort)
+        end
       end
 
-      it "returns the distinct matching fields" do
-        expect(context.distinct(:name)).to eq([ "Depeche Mode" ])
+      context "when providing an aliased field" do
+
+        let(:criteria) do
+          Band.criteria
+        end
+
+        let(:context) do
+          described_class.new(criteria)
+        end
+
+        it "returns the distinct field values" do
+          expect(context.distinct(:years).sort).to eq([ 20, 25, 30 ])
+        end
       end
-    end
 
-    context "when not limiting the result set" do
+      context 'when a collation is specified' do
+        min_server_version '3.4'
 
+        before do
+          Band.create!(name: 'DEPECHE MODE')
+        end
+
+        let(:context) do
+          described_class.new(criteria)
+        end
+
+        let(:expected_results) do
+          ["10,000 Maniacs", "Depeche Mode", "New Order"]
+        end
+
+        let(:criteria) do
+          Band.where({}).collation(locale: 'en_US', strength: 2)
+        end
+
+        it 'applies the collation' do
+          expect(context.distinct(:name).sort).to eq(expected_results.sort)
+        end
+      end
+    end
+
+    context "when providing a demongoizable field" do
       let(:criteria) do
         Band.criteria
       end
@@ -438,47 +558,241 @@ describe Mongoid::Contextual::Mongo do
         described_class.new(criteria)
       end
 
-      it "returns the distinct field values" do
-        expect(context.distinct(:name)).to eq([ "Depeche Mode", "New Order" ])
+      context "when legacy_pluck_distinct is set" do
+        config_override :legacy_pluck_distinct, true
+
+        it "returns the non-demongoized distinct field values" do
+          expect(context.distinct(:sales).sort).to eq([ "1E2", "2E3" ])
+        end
+      end
+
+      context "when legacy_pluck_distinct is not set" do
+        config_override :legacy_pluck_distinct, false
+
+        it "returns the non-demongoized distinct field values" do
+          expect(context.distinct(:sales).sort).to eq([ BigDecimal("1E2"), BigDecimal("2E3") ])
+        end
       end
     end
 
-    context "when providing an aliased field" do
+    context "when getting a localized field" do
+      before do
+        I18n.locale = :en
+        d = Dictionary.create!(description: 'english-text')
+        I18n.locale = :de
+        d.description = 'deutsch-text'
+        d.save!
+      end
 
       let(:criteria) do
-        Band.criteria
+        Dictionary.criteria
       end
 
       let(:context) do
         described_class.new(criteria)
       end
 
-      it "returns the distinct field values" do
-        expect(context.distinct(:years).sort).to eq([ 25, 30 ])
+      context "when getting the field without _translations" do
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it "gets the full hash" do
+            expect(context.distinct(:description)).to eq([{ "de" => "deutsch-text", "en" => "english-text" }])
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it "gets the demongoized localized field" do
+            expect(context.distinct(:description)).to eq([ 'deutsch-text' ])
+          end
+        end
+      end
+
+      context "when getting the field with _translations" do
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it "gets an empty list" do
+            expect(context.distinct(:description_translations)).to eq([])
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it "gets the full hash" do
+            expect(context.distinct(:description_translations)).to eq([ { "de" => "deutsch-text", "en" => "english-text" } ])
+          end
+        end
       end
-    end
 
-    context 'when a collation is specified' do
-      min_server_version '3.4'
+      context 'when plucking a specific locale' do
 
-      before do
-        Band.create(name: 'DEPECHE MODE')
+        let(:distinct) do
+          context.distinct(:'description.de')
+        end
+
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it 'returns the specific translation' do
+            expect(distinct).to eq([ 'deutsch-text' ])
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it 'returns the specific translation' do
+            expect(distinct).to eq([ "deutsch-text" ])
+          end
+        end
       end
 
-      let(:context) do
-        described_class.new(criteria)
+      context 'when plucking a specific locale from _translations field' do
+
+        let(:distinct) do
+          context.distinct(:'description_translations.de')
+        end
+
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it 'returns the empty list' do
+            expect(distinct).to eq([])
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it 'returns the specific translations' do
+            expect(distinct).to eq(['deutsch-text'])
+          end
+        end
       end
 
-      let(:expected_results) do
-        ["Depeche Mode", "New Order"]
+      context 'when fallbacks are enabled with a locale list' do
+        require_fallbacks
+
+        around(:all) do |example|
+          prev_fallbacks = I18n.fallbacks.dup
+          I18n.fallbacks[:he] = [ :en ]
+          example.run
+          I18n.fallbacks = prev_fallbacks
+        end
+
+        let(:distinct) do
+          context.distinct(:description).first
+        end
+
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it "does not correctly use the fallback" do
+            distinct.should == {"de"=>"deutsch-text", "en"=>"english-text"}
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it "correctly uses the fallback" do
+            I18n.locale = :en
+            d = Dictionary.create!(description: 'english-text')
+            I18n.locale = :he
+            distinct.should == "english-text"
+          end
+        end
       end
 
-      let(:criteria) do
-        Band.where({}).collation(locale: 'en_US', strength: 2)
+      context "when the localized field is embedded" do
+        before do
+          p = Passport.new
+          I18n.locale = :en
+          p.name = "Neil"
+          I18n.locale = :he
+          p.name = "Nissim"
+
+          Person.create!(passport: p, employer_id: 12345)
+        end
+
+        let(:criteria) do
+          Person.where(employer_id: 12345)
+        end
+
+        let(:context) do
+          described_class.new(criteria)
+        end
+
+        let(:distinct) do
+          context.distinct("pass.name").first
+        end
+
+        let(:distinct_translations) do
+          context.distinct("pass.name_translations").first
+        end
+
+        let(:distinct_translations_field) do
+          context.distinct("pass.name_translations.en").first
+        end
+
+        context "when legacy_pluck_distinct is set" do
+          config_override :legacy_pluck_distinct, true
+
+          it "returns the full hash" do
+            expect(distinct).to eq({ "en" => "Neil", "he" => "Nissim" })
+          end
+
+          it "returns the empty hash" do
+            expect(distinct_translations).to eq(nil)
+          end
+
+          it "returns the empty hash" do
+            expect(distinct_translations_field).to eq(nil)
+          end
+        end
+
+        context "when legacy_pluck_distinct is not set" do
+          config_override :legacy_pluck_distinct, false
+
+          it "returns the translation for the current locale" do
+            expect(distinct).to eq("Nissim")
+          end
+
+          it "returns the full _translation hash" do
+            expect(distinct_translations).to eq({ "en" => "Neil", "he" => "Nissim" })
+          end
+
+          it "returns the translation for the requested locale" do
+            expect(distinct_translations_field).to eq("Neil")
+          end
+        end
       end
+    end
+
+    context "when getting an embedded field" do
 
-      it 'applies the collation' do
-        expect(context.distinct(:name)).to eq(expected_results)
+      let(:label) { Label.new(sales: "1E2") }
+      let!(:band) { Band.create!(label: label) }
+      let(:criteria) { Band.where(_id: band.id) }
+      let(:context) { described_class.new(criteria) }
+
+      context "when legacy_pluck_distinct is set" do
+        config_override :legacy_pluck_distinct, true
+
+        it "returns the distinct matching fields" do
+          expect(context.distinct("label.sales")).to eq([ "1E2" ])
+        end
+      end
+
+      context "when legacy_pluck_distinct is not set" do
+        config_override :legacy_pluck_distinct, false
+        it "returns the distinct matching fields" do
+          expect(context.distinct("label.sales")).to eq([ BigDecimal("1E2") ])
+        end
       end
     end
   end
@@ -486,7 +800,7 @@ describe Mongoid::Contextual::Mongo do
   describe "#each" do
 
     before do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let(:criteria) do
@@ -564,7 +878,7 @@ describe Mongoid::Contextual::Mongo do
         context "when iterating with next" do
 
           before do
-            10.times { |i| Band.create(name: "Test #{i}") }
+            10.times { |i| Band.create!(name: "Test #{i}") }
           end
 
           let(:criteria) do
@@ -576,8 +890,21 @@ describe Mongoid::Contextual::Mongo do
           end
 
           it "does not load all documents" do
-            expect(Mongo::Logger.logger).to receive(:debug?).exactly(2).times.and_call_original
+            subscriber = Mrss::EventSubscriber.new
+            context.view.client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+
             enum.next
+
+            find_events = subscriber.all_events.select do |evt|
+              evt.command_name == 'find'
+            end
+            expect(find_events.length).to be(2)
+            get_more_events = subscriber.all_events.select do |evt|
+              evt.command_name == 'getMore'
+            end
+            expect(get_more_events.length).to be(0)
+          ensure
+            context.view.client.unsubscribe(Mongo::Monitoring::COMMAND, subscriber)
           end
         end
       end
@@ -586,9 +913,9 @@ describe Mongoid::Contextual::Mongo do
     context 'when the criteria has a parent document' do
 
       before do
-        Post.create(person: person)
-        Post.create(person: person)
-        Post.create(person: person)
+        Post.create!(person: person)
+        Post.create!(person: person)
+        Post.create!(person: person)
       end
 
       let(:person) do
@@ -635,7 +962,7 @@ describe Mongoid::Contextual::Mongo do
   describe "#exists?" do
 
     before do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     context "when the count is zero" do
@@ -748,11 +1075,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#find_one_and_replace" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:tool) do
-      Band.create(name: "Tool")
+      Band.create!(name: "Tool")
     end
 
     context "when the selector matches" do
@@ -904,11 +1231,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#find_one_and_update" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:tool) do
-      Band.create(name: "Tool")
+      Band.create!(name: "Tool")
     end
 
     context "when the selector matches" do
@@ -1057,7 +1384,7 @@ describe Mongoid::Contextual::Mongo do
   describe "#find_one_and_delete" do
 
     let!(:depeche) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let(:criteria) do
@@ -1136,11 +1463,11 @@ describe Mongoid::Contextual::Mongo do
     describe "##{method}" do
 
       let!(:depeche_mode) do
-        Band.create(name: "Depeche Mode")
+        Band.create!(name: "Depeche Mode")
       end
 
       let!(:new_order) do
-        Band.create(name: "New Order")
+        Band.create!(name: "New Order")
       end
 
       context "when the context is not cached" do
@@ -1377,8 +1704,8 @@ describe Mongoid::Contextual::Mongo do
     describe "##{method}" do
 
       before do
-        Band.create(name: "Depeche Mode")
-        Band.create(name: "New Order")
+        Band.create!(name: "Depeche Mode")
+        Band.create!(name: "New Order")
       end
 
       context "when the criteria has a limit" do
@@ -1396,12 +1723,8 @@ describe Mongoid::Contextual::Mongo do
         end
 
         context "when calling more than once" do
-
-          before do
-            expect(context.view).to receive(:count).once.and_return(2)
-          end
-
           it "returns the cached value for subsequent calls" do
+            expect(context.view).to receive(:count_documents).once.and_return(2)
             2.times { expect(context.send(method)).to eq(2) }
           end
         end
@@ -1410,10 +1733,10 @@ describe Mongoid::Contextual::Mongo do
 
           before do
             context.entries
-            expect(context.view).to receive(:count).once.and_return(2)
           end
 
           it "returns the cached value for all calls" do
+            expect(context.view).to receive(:count_documents).once.and_return(2)
             expect(context.send(method)).to eq(2)
           end
 
@@ -1445,12 +1768,8 @@ describe Mongoid::Contextual::Mongo do
         end
 
         context "when calling more than once" do
-
-          before do
-            expect(context.view).to receive(:count).once.and_return(1)
-          end
-
           it "returns the cached value for subsequent calls" do
+            expect(context.view).to receive(:count_documents).once.and_return(1)
             2.times { expect(context.send(method)).to eq(1) }
           end
         end
@@ -1459,10 +1778,10 @@ describe Mongoid::Contextual::Mongo do
 
           before do
             context.entries
-            expect(context.view).to receive(:count).once.and_return(1)
           end
 
           it "returns the cached value for all calls" do
+            expect(context.view).to receive(:count_documents).once.and_return(1)
             expect(context.send(method)).to eq(1)
           end
 
@@ -1484,11 +1803,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#limit" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -1507,8 +1826,8 @@ describe Mongoid::Contextual::Mongo do
   describe "#map" do
 
     before do
-      Band.create(name: "Depeche Mode")
-      Band.create(name: "New Order")
+      Band.create!(name: "Depeche Mode")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -1537,11 +1856,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#map_reduce" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode", likes: 200)
+      Band.create!(name: "Depeche Mode", likes: 200)
     end
 
     let!(:tool) do
-      Band.create(name: "Tool", likes: 100)
+      Band.create!(name: "Tool", likes: 100)
     end
 
     let(:map) do
@@ -1848,6 +2167,8 @@ describe Mongoid::Contextual::Mongo do
     end
 
     context "when the output specifies a different db" do
+      # Limit is not supported in sharded clusters
+      require_topology :single, :replica_set
 
       let(:criteria) do
         Band.limit(1)
@@ -1964,11 +2285,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#skip" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -1987,11 +2308,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#sort" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -2030,11 +2351,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#update" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode")
+      Band.create!(name: "Depeche Mode")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -2048,11 +2369,11 @@ describe Mongoid::Contextual::Mongo do
     context "when adding an element to a HABTM set" do
 
       let(:person) do
-        Person.create
+        Person.create!
       end
 
       let(:preference) do
-        Preference.create
+        Preference.create!
       end
 
       before do
@@ -2191,12 +2512,12 @@ describe Mongoid::Contextual::Mongo do
         b.labels << Label.new(name: 'Warner')
         b.labels << Label.new(name: 'Sony')
         b.labels << Label.new(name: 'Cbs')
-        b.save
+        b.save!
 
         b = Band.new(name: 'FKA Twigs')
         b.labels << Label.new(name: 'Warner')
         b.labels << Label.new(name: 'Cbs')
-        b.save
+        b.save!
       end
 
 
@@ -2222,11 +2543,11 @@ describe Mongoid::Contextual::Mongo do
   describe "#update_all" do
 
     let!(:depeche_mode) do
-      Band.create(name: "Depeche Mode", origin: "Essex")
+      Band.create!(name: "Depeche Mode", origin: "Essex")
     end
 
     let!(:new_order) do
-      Band.create(name: "New Order")
+      Band.create!(name: "New Order")
     end
 
     let(:criteria) do
@@ -2364,12 +2685,12 @@ describe Mongoid::Contextual::Mongo do
         b.labels << Label.new(name: 'Warner')
         b.labels << Label.new(name: 'Sony')
         b.labels << Label.new(name: 'Cbs')
-        b.save
+        b.save!
 
         b = Band.new(name: 'FKA Twigs')
         b.labels << Label.new(name: 'Warner')
         b.labels << Label.new(name: 'Cbs')
-        b.save
+        b.save!
       end