mongoid 8.0.10 → 8.1.0

data/spec/mongoid/changeable_spec.rb

@@ -476,6 +476,188 @@ describe Mongoid::Changeable do
         end
       end
     end
+
+    context "when including key word args" do
+
+      let(:person) { Person.new }
+
+      context "when only including from" do
+
+        context "when the object has not changed" do
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, from: nil)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil)).to be false
+          end
+        end
+
+        context "when the object has changed from the wrong item" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, from: 1)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(from: 1)).to be false
+          end
+        end
+
+        context "when the object has changed from the correct item" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns true" do
+            expect(person.send(:attribute_changed?, :score, from: nil)).to be true
+          end
+
+          it "returns true using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil)).to be true
+          end
+        end
+      end
+
+      context "when only including to" do
+
+        context "when the object has not changed" do
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, to: nil)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(to: nil)).to be false
+          end
+        end
+
+        context "when the object has changed to the wrong item" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, to: 1)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(to: 1)).to be false
+          end
+        end
+
+        context "when the object has changed to the correct item" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns true" do
+            expect(person.send(:attribute_changed?, :score, to: 2)).to be true
+          end
+
+          it "returns true using (attribute)_changed?" do
+            expect(person.score_changed?(to: 2)).to be true
+          end
+        end
+      end
+
+      context "when including from and to" do
+
+        context "when the object has not changed" do
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, from: nil, to: nil)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil, to: nil)).to be false
+          end
+        end
+
+        context "when only the from is correct" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, from: nil, to: 3)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil, to: 3)).to be false
+          end
+        end
+
+        context "when only the to is correct" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns false" do
+            expect(person.send(:attribute_changed?, :score, from: 1, to: 2)).to be false
+          end
+
+          it "returns false using (attribute)_changed?" do
+            expect(person.score_changed?(from: 1, to: 2)).to be false
+          end
+        end
+
+        context "when the from and to are correct" do
+
+          before do
+            person.score = 2
+          end
+
+          it "returns true" do
+            expect(person.send(:attribute_changed?, :score, from: nil, to: 2)).to be true
+          end
+
+          it "returns true using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil, to: 2)).to be true
+          end
+        end
+
+        context "when value is mongoized" do
+
+          before do
+            person.score = "2"
+          end
+
+          it "returns true with mongoized value" do
+            expect(person.send(:attribute_changed?, :score, from: nil, to: 2)).to be true
+          end
+
+          it "returns true with mongoized value using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil, to: 2)).to be true
+          end
+        end
+
+        context "when value is mongoized" do
+
+          before do
+            person.score = "2"
+          end
+
+          it "returns false with unmongoized value" do
+            expect(person.send(:attribute_changed?, :score, from: nil, to: "2")).to be false
+          end
+
+          it "returns false with unmongoized value using (attribute)_changed?" do
+            expect(person.score_changed?(from: nil, to: "2")).to be false
+          end
+        end
+      end
+    end
   end
 
   describe "#attribute_changed_from_default?" do
@@ -1167,20 +1349,10 @@ describe Mongoid::Changeable do
 
       context "when the document is embedded" do
 
-        let(:person) do
-          Person.instantiate(title: "Grand Poobah")
-        end
+        let(:person) { Person.create(title: "Grand Poobah") }
+        let(:address) { person.addresses.create(street: "Oxford St") }
 
-        let(:address) do
-          Address.instantiate(street: "Oxford St")
-        end
-
-        before do
-          person.addresses << address
-          person.instance_variable_set(:@new_record, false)
-          address.instance_variable_set(:@new_record, false)
-          address.street = "Bond St"
-        end
+        before { address.street = "Bond St" }
 
         it "returns a hash of field names and new values" do
           expect(address.setters).to eq(
@@ -1189,17 +1361,9 @@ describe Mongoid::Changeable do
         end
 
         context "when the document is embedded multiple levels" do
-
-          let(:location) do
-            Location.new(name: "Home")
-          end
-
-          before do
-            location.instance_variable_set(:@new_record, false)
-            address.locations << location
-            location.name = "Work"
-          end
-
+          let(:location) { address.locations.create(name: "Home") }
+          before { location.name = "Work" }
+          
           it "returns the proper hash with locations" do
             expect(location.setters).to eq(
               { "addresses.0.locations.0.name" => "Work" }
@@ -1479,6 +1643,117 @@ describe Mongoid::Changeable do
     end
   end
 
+  describe '#attribute_before_last_save' do
+    let(:person) do
+      Person.create!(title: "Grand Poobah")
+    end
+
+    before do
+      person.title = "Captain Obvious"
+    end
+
+    context "when the document has been saved" do
+      before do
+        person.save!
+      end
+
+      it "returns the changes" do
+        expect(person.attribute_before_last_save(:title)).to eq("Grand Poobah")
+        expect(person.title_before_last_save).to eq("Grand Poobah")
+      end
+    end
+
+    context "when the document has not been saved" do
+      it "returns no changes" do
+        expect(person.attribute_before_last_save(:title)).to be_nil
+        expect(person.title_before_last_save).to be_nil
+      end
+    end
+  end
+
+  describe '#saved_change_to_attribute' do
+    let(:person) do
+      Person.create!(title: "Grand Poobah")
+    end
+
+    before do
+      person.title = "Captain Obvious"
+    end
+
+    context "when the document has been saved" do
+      before do
+        person.save!
+      end
+
+      it "returns the changes" do
+        expect(person.saved_change_to_attribute(:title)).to eq(["Grand Poobah", "Captain Obvious"])
+        expect(person.saved_change_to_title).to eq(["Grand Poobah", "Captain Obvious"])
+      end
+    end
+
+    context "when the document has not been saved" do
+      it "returns changes for the previous save" do
+        expect(person.saved_change_to_attribute(:title)).to eq([nil, "Grand Poobah"])
+        expect(person.saved_change_to_title).to eq([nil, "Grand Poobah"])
+      end
+    end
+  end
+
+  describe '#saved_change_to_attribute?' do
+    context "when the document has been saved" do
+      let(:person) do
+        Person.create!(title: "Grand Poobah")
+      end
+
+      before do
+        person.title = "Captain Obvious"
+      end
+
+      before do
+        person.save!
+      end
+
+      it "detects the changes" do
+        expect(person.saved_change_to_attribute?(:title)).to be_truthy
+        expect(person.saved_change_to_attribute?(:title, from: "Grand Poobah")).to be_truthy
+        expect(person.saved_change_to_attribute?(:title, to: "Captain Obvious")).to be_truthy
+        expect(person.saved_change_to_attribute?(:title, from: "Grand Poobah", to: "Captain Obvious")).to be_truthy
+        expect(person.saved_change_to_title?(from: "Grand Poobah", to: "Captain Obvious")).to be_truthy
+        expect(person.saved_change_to_attribute?(:age)).to be_falsey
+        expect(person.saved_change_to_age?).to be_falsey
+      end
+    end
+
+    context "when the document has not been saved" do
+      let(:person) do
+        Person.new(title: "Grand Poobah")
+      end
+
+      it "returns changes for the previous save" do
+        expect(person.saved_change_to_attribute?(:title)).to be_falsey
+        expect(person.saved_change_to_title?).to be_falsey
+      end
+    end
+  end
+
+  describe '#will_save_change_to_attribute?' do
+    let(:person) do
+      Person.create!(title: "Grand Poobah")
+    end
+
+    before do
+      person.title = "Captain Obvious"
+    end
+
+    it 'correctly detects changes' do
+      expect(person.will_save_change_to_attribute?(:title)).to eq(true)
+      expect(person.will_save_change_to_title?).to eq(true)
+      expect(person.will_save_change_to_attribute?(:score)).to eq(false)
+      expect(person.will_save_change_to_score?).to eq(false)
+    end
+
+  end
+
   context "when fields have been defined pre-dirty inclusion" do
 
     let(:document) do

data/spec/mongoid/clients_spec.rb

@@ -738,19 +738,6 @@ describe Mongoid::Clients do
       end
     end
 
-    context "when provided a class that extends another document" do
-
-      let(:klass) do
-        Class.new(Band)
-      end
-
-      it "raises an error" do
-        expect {
-          klass.store_in(database: :artists)
-        }.to raise_error(Mongoid::Errors::InvalidStorageParent)
-      end
-    end
-
     context "when provided a hash" do
 
       context "when the hash is not valid" do
@@ -762,6 +749,128 @@ describe Mongoid::Clients do
         end
       end
     end
+
+    context "when it is called on a subclass" do
+
+      let(:client) { StoreParent.collection.client }
+      let(:parent) { StoreParent.create! }
+      let(:child1) { StoreChild1.create! }
+      let(:child2) { StoreChild2.create! }
+
+      before do
+        class StoreParent
+          include Mongoid::Document
+        end
+
+        class StoreChild1 < StoreParent
+        end
+
+        class StoreChild2 < StoreParent
+        end
+      end
+
+      after do
+        Object.send(:remove_const, :StoreParent)
+        Object.send(:remove_const, :StoreChild1)
+        Object.send(:remove_const, :StoreChild2)
+      end
+
+      context "when it is not called on the parent" do
+
+        context "when it is called on all subclasses" do
+
+          before do
+            StoreChild1.store_in collection: :store_ones
+            StoreChild2.store_in collection: :store_twos
+            [ parent, child1, child2 ]
+          end
+
+          let(:db_parent) { client['store_parents'].find.first }
+          let(:db_child1) { client['store_ones'].find.first }
+          let(:db_child2) { client['store_twos'].find.first }
+
+          it "stores the documents in the correct collections" do
+            expect(db_parent).to eq({ "_id" => parent.id, "_type" => "StoreParent" })
+            expect(db_child1).to eq({ "_id" => child1.id, "_type" => "StoreChild1" })
+            expect(db_child2).to eq({ "_id" => child2.id, "_type" => "StoreChild2" })
+          end
+
+          it "only queries from its own collections" do
+            expect(StoreParent.count).to eq(1)
+            expect(StoreChild1.count).to eq(1)
+            expect(StoreChild2.count).to eq(1)
+          end
+        end
+
+        context "when it is called on one of the subclasses" do
+
+          before do
+            StoreChild1.store_in collection: :store_ones
+            [ parent, child1, child2 ]
+          end
+
+          let(:db_parent) { client['store_parents'].find.first }
+          let(:db_child1) { client['store_ones'].find.first }
+          let(:db_child2) { client['store_parents'].find.to_a.last }
+
+          it "stores the documents in the correct collections" do
+            expect(db_parent).to eq({ "_id" => parent.id, "_type" => "StoreParent" })
+            expect(db_child1).to eq({ "_id" => child1.id, "_type" => "StoreChild1" })
+            expect(db_child2).to eq({ "_id" => child2.id, "_type" => "StoreChild2" })
+          end
+
+          it "queries from its own collections" do
+            expect(StoreParent.count).to eq(2)
+            expect(StoreChild1.count).to eq(1)
+            expect(StoreChild2.count).to eq(1)
+          end
+        end
+      end
+
+      context "when it is called on the parent" do
+
+        before do
+          StoreParent.store_in collection: :st_parents
+        end
+
+        context "when it is called on all subclasses" do
+
+          before do
+            StoreChild1.store_in collection: :store_ones
+            StoreChild2.store_in collection: :store_twos
+            [ parent, child1, child2 ]
+          end
+
+          let(:db_parent) { client['st_parents'].find.first }
+          let(:db_child1) { client['store_ones'].find.first }
+          let(:db_child2) { client['store_twos'].find.first }
+
+          it "stores the documents in the correct collections" do
+            expect(db_parent).to eq({ "_id" => parent.id, "_type" => "StoreParent" })
+            expect(db_child1).to eq({ "_id" => child1.id, "_type" => "StoreChild1" })
+            expect(db_child2).to eq({ "_id" => child2.id, "_type" => "StoreChild2" })
+          end
+        end
+
+        context "when it is called on one of the subclasses" do
+
+          before do
+            StoreChild1.store_in collection: :store_ones
+            [ parent, child1, child2 ]
+          end
+
+          let(:db_parent) { client['st_parents'].find.first }
+          let(:db_child1) { client['store_ones'].find.first }
+          let(:db_child2) { client['st_parents'].find.to_a.last }
+
+          it "stores the documents in the correct collections" do
+            expect(db_parent).to eq({ "_id" => parent.id, "_type" => "StoreParent" })
+            expect(db_child1).to eq({ "_id" => child1.id, "_type" => "StoreChild1" })
+            expect(db_child2).to eq({ "_id" => child2.id, "_type" => "StoreChild2" })
+          end
+        end
+      end
+    end
   end
 
   describe ".with" do

data/spec/mongoid/collection_configurable_spec.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::CollectionConfigurable do
+
+  before(:all) do
+    class CollectionConfigurableValidOptions
+      include Mongoid::Document
+
+      store_in collection_options: {
+        capped: true,
+        size: 2560
+      }
+    end
+
+    class CollectionConfigurableUnknownOptions
+      include Mongoid::Document
+
+      store_in collection_options: {
+        i_am_not_an_option: true,
+        let_me: { fail: true }
+      }
+    end
+
+    class CollectionConfigurableInvalidOptions
+      include Mongoid::Document
+
+      store_in collection_options: {
+        capped: true
+        # Creating a capped collection requires `size` field; therefore,
+        # an attempt to create a collection with only `capped : true` option
+        # fails.
+      }
+    end
+  end
+
+  after(:all) do
+    Mongoid.deregister_model(CollectionConfigurableValidOptions)
+    Object.send(:remove_const, :CollectionConfigurableValidOptions)
+    Mongoid.deregister_model(CollectionConfigurableUnknownOptions)
+    Object.send(:remove_const, :CollectionConfigurableUnknownOptions)
+    Mongoid.deregister_model(CollectionConfigurableInvalidOptions)
+    Object.send(:remove_const, :CollectionConfigurableInvalidOptions)
+  end
+
+  after(:each) do
+    [
+      CollectionConfigurableValidOptions,
+      CollectionConfigurableUnknownOptions
+    ].each do |klazz|
+      klazz.collection.drop
+    end
+  end
+
+  context 'when collection does not exist' do
+    context 'with valid options' do
+      let(:subject) do
+        CollectionConfigurableValidOptions
+      end
+
+      before(:each) do
+        subject.create_collection
+      end
+
+      let(:coll_options) do
+        subject.collection.database.list_collections(filter: { name: subject.collection_name.to_s }).first
+      end
+
+      it 'creates the collection' do
+        expect(coll_options).not_to be_nil
+      end
+
+      it 'passes collection options' do
+        expect(coll_options.dig('options', 'capped')).to eq(true)
+        expect(coll_options.dig('options', 'size')).to eq(2560)
+      end
+    end
+
+    context 'with an unknown collection options' do
+      let(:subject) do
+        CollectionConfigurableUnknownOptions
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.create_collection
+        end.to raise_error(Mongoid::Errors::CreateCollectionFailure)
+      end
+    end
+
+    context 'with invalid options' do
+      let(:subject) do
+        CollectionConfigurableInvalidOptions
+      end
+
+      it 'raises an error' do
+        expect do
+          subject.create_collection
+        end.to raise_error(Mongoid::Errors::CreateCollectionFailure)
+      end
+    end
+  end
+
+  context 'when collection exists' do
+    let(:subject) do
+      CollectionConfigurableValidOptions
+    end
+
+    context 'when force is false' do
+      let(:logger) do
+        double("logger").tap do |log|
+          expect(log).to receive(:debug).once.with(/Collection '#{subject.collection_name}' already exist/)
+        end
+      end
+
+      before do
+        allow(subject).to receive(:logger).and_return(logger)
+        subject.collection.create
+      end
+
+      it 'logs a message' do
+        subject.create_collection
+      end
+    end
+
+    context 'when force is true' do
+      let(:logger) do
+        double("logger")
+      end
+
+      let(:coll_options) do
+        subject.collection.database.list_collections(filter: { name: subject.collection_name.to_s }).first
+      end
+
+      before do
+        allow(subject).to receive(:logger).and_return(logger)
+        subject.collection.create
+      end
+
+      it 'does not log a message' do
+        expect(logger).to receive(:debug).never.with(/Collection '#{subject.collection_name}' already exist/)
+        subject.create_collection(force: true)
+      end
+
+      it 'creates the collection' do
+        subject.create_collection(force: true)
+        expect(coll_options).not_to be_nil
+      end
+
+      it 'passes collection options' do
+        subject.create_collection(force: true)
+        expect(coll_options.dig('options', 'capped')).to eq(true)
+        expect(coll_options.dig('options', 'size')).to eq(2560)
+      end
+    end
+  end
+end