mongoid 4.0.2 → 5.0.0

data/spec/mongoid/clients_spec.rb

@@ -0,0 +1,754 @@
+require "spec_helper"
+
+describe Mongoid::Clients do
+
+  describe "#collection" do
+
+    shared_examples_for "an overridden collection at the class level" do
+
+      let(:band) do
+        klass.new
+      end
+
+      it "returns the collection for the model" do
+        expect(band.collection).to be_a(Mongo::Collection)
+      end
+
+      it "sets the correct collection name" do
+        expect(band.collection.name).to eq("artists")
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the collection for the model" do
+          expect(klass.collection).to be_a(Mongo::Collection)
+        end
+
+        it "sets the correct collection name" do
+          expect(klass.collection.name).to eq("artists")
+        end
+      end
+    end
+
+    context "when overriding the persistence options" do
+
+      let(:klass) do
+        Band.with(collection: "artists")
+      end
+
+      it_behaves_like "an overridden collection at the class level"
+    end
+
+    context "when overriding store_in and persistence options" do
+
+      let(:klass) do
+        Band.with(collection: "artists")
+      end
+
+      before do
+        Band.store_in collection: "foo"
+      end
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      it_behaves_like "an overridden collection at the class level"
+    end
+
+    context "when overriding the default with store_in" do
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      context "when called multiple times with different options" do
+
+        before do
+          Band.store_in collection: "artists"
+          Band.store_in client: "another"
+        end
+
+        it "should merge the options together" do
+          expect(Band.storage_options[:collection]).to eq("artists")
+          expect(Band.storage_options[:client]).to eq("another")
+        end
+      end
+
+      context "when overriding with a proc" do
+
+        let(:klass) { Band }
+
+        before do
+          Band.store_in(collection: ->{ "artists" })
+        end
+
+        it_behaves_like "an overridden collection at the class level"
+      end
+
+      context "when overriding with a string" do
+
+        let(:klass) { Band }
+
+        before do
+          Band.store_in(collection: "artists")
+        end
+
+        after do
+          Band.reset_storage_options!
+        end
+
+        it_behaves_like "an overridden collection at the class level"
+      end
+
+      context "when overriding with a symbol" do
+
+        let(:klass) { Band }
+
+        before do
+          klass.store_in(collection: :artists)
+        end
+
+        after do
+          klass.reset_storage_options!
+        end
+
+        it_behaves_like "an overridden collection at the class level"
+      end
+    end
+
+    context "when not overriding the default" do
+
+      let(:band) do
+        Band.new
+      end
+
+      it "returns the collection for the model" do
+        expect(band.collection).to be_a(Mongo::Collection)
+      end
+
+      it "sets the correct collection name" do
+        expect(band.collection.name.to_s).to eq("bands")
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the collection for the model" do
+          expect(Band.collection).to be_a(Mongo::Collection)
+        end
+
+        it "sets the correct collection name" do
+          expect(Band.collection.name.to_s).to eq("bands")
+        end
+      end
+    end
+  end
+
+  describe "#collection_name" do
+
+    shared_examples_for "an overridden collection name at the class level" do
+
+      let(:band) do
+        klass.new
+      end
+
+      context "when accessing from the instance" do
+
+        it "returns the overridden value" do
+          expect(band.collection_name).to eq(:artists)
+        end
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the overridden value" do
+          expect(klass.collection_name).to eq(:artists)
+        end
+      end
+    end
+
+    context "when overriding the persistence options" do
+
+      let(:klass) do
+        Band.with(collection: "artists")
+      end
+
+      it_behaves_like "an overridden collection name at the class level"
+    end
+
+    context "when overriding store_in and persistence options" do
+
+      let(:klass) do
+        Band.with(collection: "artists")
+      end
+
+      before do
+        Band.store_in collection: "foo"
+      end
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      it_behaves_like "an overridden collection name at the class level"
+    end
+
+    context "when overriding the default with store_in" do
+
+      let(:klass) { Band }
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      context "when overriding with a proc" do
+
+        before do
+          Band.store_in(collection: ->{ "artists" })
+        end
+
+        it_behaves_like "an overridden collection name at the class level"
+      end
+
+      context "when overriding with a string" do
+
+        before do
+          Band.store_in(collection: "artists")
+        end
+
+        it_behaves_like "an overridden collection name at the class level"
+      end
+
+      context "when overriding with a symbol" do
+
+        before do
+          Band.store_in(collection: :artists)
+        end
+
+        it_behaves_like "an overridden collection name at the class level"
+      end
+    end
+
+    context "when not overriding the default" do
+
+      let(:band) do
+        Band.new
+      end
+
+      it "returns the pluralized model name" do
+        expect(band.collection_name).to eq(:bands)
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the pluralized model name" do
+          expect(Band.collection_name).to eq(:bands)
+        end
+      end
+    end
+
+    context "when the model is a subclass" do
+
+      let(:firefox) do
+        Firefox.new
+      end
+
+      it "returns the root class pluralized model name" do
+        expect(firefox.collection_name).to eq(:canvases)
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the root class pluralized model name" do
+          expect(Firefox.collection_name).to eq(:canvases)
+        end
+      end
+    end
+  end
+
+  describe "#database_name", if: non_legacy_server? do
+
+    shared_examples_for "an overridden database name" do
+
+      let(:band) do
+        klass.new
+      end
+
+      context "when accessing from the instance" do
+
+        it "returns the overridden value" do
+          # @todo
+          # expect(band.mongo_client.options[:database].to_s).to eq(database_id_alt)
+        end
+      end
+
+      context "when accessing from the class level" do
+
+        it "returns the overridden value" do
+          expect(klass.database_name.to_s).to eq(database_id_alt)
+        end
+
+        it "client returns the overridden value" do
+          expect(klass.mongo_client.options[:database].to_s).to eq(database_id_alt)
+        end
+      end
+    end
+
+    context "when overriding the persistence options" do
+
+      let(:klass) do
+        Band.with(database: database_id_alt)
+      end
+
+      it_behaves_like "an overridden database name"
+    end
+
+    context "when overriding with store_in" do
+
+      let(:klass) { Band }
+
+      before do
+        Band.store_in database: database_id_alt
+      end
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      it_behaves_like "an overridden database name"
+    end
+
+    context "when overriding store_in and persistence options" do
+
+      let(:klass) do
+        Band.with(database: database_id_alt)
+      end
+
+      before do
+        Band.store_in database: "foo"
+      end
+
+      after do
+        Band.reset_storage_options!
+      end
+
+      it_behaves_like "an overridden database name"
+    end
+
+    context "when overriding using the client" do
+
+      let(:client_name) { :alternative }
+
+      before do
+        Mongoid.clients[client_name] = { database: database_id_alt, hosts: [ "#{HOST}:#{PORT}" ] }
+      end
+
+      after do
+        Mongoid.clients.delete(client_name)
+      end
+
+      context "when overriding the persistence options" do
+
+        let(:klass) do
+          Band.with(client: client_name)
+        end
+
+        it_behaves_like "an overridden database name"
+      end
+
+      context "when overriding with store_in" do
+
+        let(:klass) { Band }
+
+        before do
+          Band.store_in(client: client_name)
+        end
+
+        after do
+          Band.reset_storage_options!
+        end
+
+        it_behaves_like "an overridden database name"
+      end
+    end
+  end
+
+  describe "#mongo_client", if: non_legacy_server? do
+
+    let(:file) do
+      File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
+    end
+
+    before do
+      described_class.clear
+      Mongoid.load!(file, :test)
+      Mongoid.clients[:default][:database] = database_id
+    end
+
+    context "when getting the default" do
+
+      let(:file) do
+        File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
+      end
+
+      before do
+        described_class.clear
+        Mongoid.load!(file, :test)
+        Mongoid.clients[:default][:database] = database_id
+      end
+
+      let!(:band) do
+        Band.new
+      end
+
+      let!(:mongo_client) do
+        band.mongo_client
+      end
+
+      it "returns the default client" do
+        expect(mongo_client.options[:database].to_s).to eq(database_id)
+      end
+    end
+
+    context "when no client exists with the key" do
+
+      before(:all) do
+        Band.store_in(client: :nonexistant)
+      end
+
+      let(:band) do
+        Band.new
+      end
+
+      it "raises an error" do
+        expect {
+          band.mongo_client
+        }.to raise_error(Mongoid::Errors::NoClientConfig)
+      end
+    end
+  end
+
+  describe ".mongo_client", if: non_legacy_server? do
+
+    let(:file) do
+      File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
+    end
+
+    before do
+      described_class.clear
+      Mongoid.load!(file, :test)
+      Mongoid.clients[:default][:database] = database_id
+    end
+
+    after do
+      Band.reset_storage_options!
+    end
+
+    context "when getting the default" do
+
+      let(:file) do
+        File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
+      end
+
+      before do
+        Band.reset_storage_options!
+        described_class.clear
+        Mongoid.load!(file, :test)
+        Mongoid.clients[:default][:database] = database_id
+      end
+
+      let!(:mongo_client) do
+        Band.mongo_client
+      end
+
+      it "returns the default client" do
+        expect(mongo_client.options[:database].to_s).to eq(database_id)
+      end
+    end
+
+    context "when no client exists with the key" do
+
+      before(:all) do
+        Band.store_in(client: :nonexistant)
+      end
+
+      it "raises an error" do
+        expect {
+          Band.mongo_client
+        }.to raise_error(Mongoid::Errors::NoClientConfig)
+      end
+    end
+  end
+
+  describe ".store_in", if: non_legacy_server? do
+
+    context "when provided a non hash" do
+
+      it "raises an error" do
+        expect {
+          Band.store_in :artists
+        }.to raise_error(Mongoid::Errors::InvalidStorageOptions)
+      end
+    end
+
+    context "when provided a class that extend 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
+
+        it "raises an error" do
+          expect {
+            Band.store_in coll: "artists"
+          }.to raise_error(Mongoid::Errors::InvalidStorageOptions)
+        end
+      end
+    end
+  end
+
+  describe ".with", if: non_legacy_server? do
+
+    context "when changing write concern options" do
+
+      let(:client_one) do
+        Band.with(write: { w: 2 }).mongo_client
+      end
+
+      let(:client_two) do
+        Band.mongo_client
+      end
+
+      it "does not carry over the options" do
+        expect(client_one.write_concern).to_not eq(client_two.write_concern)
+      end
+    end
+
+    context "when sending operations to a different database" do
+
+      after do
+        Band.with(database: database_id_alt).delete_all
+      end
+
+      describe ".create" do
+
+        let!(:band) do
+          Band.with(database: database_id_alt).create
+        end
+
+        it "does not persist to the default database" do
+          expect {
+            Band.find(band.id)
+          }.to raise_error(Mongoid::Errors::DocumentNotFound)
+        end
+
+        let(:from_db) do
+          Band.with(database: database_id_alt).find(band.id)
+        end
+
+        it "persists to the specified database" do
+          expect(from_db).to eq(band)
+        end
+
+        it "persists the correct number of documents" do
+          expect(Band.with(database: database_id_alt).count).to eq(1)
+        end
+      end
+    end
+
+    context "when sending operations to a different collection" do
+
+      describe ".create" do
+
+        let!(:band) do
+          Band.with(collection: "artists").create
+        end
+
+        it "does not persist to the default database" do
+          expect {
+            Band.find(band.id)
+          }.to raise_error(Mongoid::Errors::DocumentNotFound)
+        end
+
+        let(:from_db) do
+          Band.with(collection: "artists").find(band.id)
+        end
+
+        it "persists to the specified database" do
+          expect(from_db).to eq(band)
+        end
+
+        it "persists the correct number of documents" do
+          expect(Band.with(collection: "artists").count).to eq(1)
+        end
+      end
+    end
+
+    context "when sending operations with safe mode" do
+
+      describe ".create" do
+
+        before do
+          Person.create_indexes
+          Person.create(ssn: "432-97-1111")
+        end
+
+        context "when no error occurs" do
+
+          it "inserts the document" do
+            expect(Person.count).to eq(1)
+          end
+        end
+
+        context "when a mongodb error occurs" do
+
+          it "bubbles up to the caller" do
+            expect {
+              Person.create(ssn: "432-97-1111")
+            }.to raise_error(Mongo::Error::OperationFailure)
+          end
+        end
+      end
+
+      describe ".create!" do
+
+        before do
+          Person.create!(ssn: "432-97-1112")
+        end
+
+        context "when no error occurs" do
+
+          it "inserts the document" do
+            expect(Person.count).to eq(1)
+          end
+        end
+
+        context "when a mongodb error occurs" do
+
+          before do
+            Person.create_indexes
+          end
+
+          it "bubbles up to the caller" do
+            expect {
+              Person.create!(ssn: "432-97-1112")
+            }.to raise_error(Mongo::Error::OperationFailure)
+          end
+        end
+
+        context "when a validation error occurs" do
+
+          it "raises the validation error" do
+            expect {
+              Account.create!(name: "this name is way too long")
+            }.to raise_error(Mongoid::Errors::Validations)
+          end
+        end
+      end
+
+      describe ".save" do
+
+        before do
+          Person.create(ssn: "432-97-1113")
+        end
+
+        context "when a mongodb error occurs" do
+
+          let(:person) do
+            Person.new(ssn: "432-97-1113")
+          end
+
+          before do
+            Person.create_indexes
+          end
+
+          it "bubbles up to the caller" do
+            expect {
+              person.save
+            }.to raise_error(Mongo::Error::OperationFailure)
+          end
+        end
+      end
+
+      describe ".save!" do
+
+        before do
+          Person.create!(ssn: "432-97-1114")
+        end
+
+        context "when a mongodb error occurs" do
+
+          let(:person) do
+            Person.new(ssn: "432-97-1114")
+          end
+
+          before do
+            Person.create_indexes
+          end
+
+          it "bubbles up to the caller" do
+            expect {
+              person.save!
+            }.to raise_error(Mongo::Error::OperationFailure)
+          end
+        end
+
+        context "when a validation error occurs" do
+
+          let(:account) do
+            Account.new(name: "this name is way too long")
+          end
+
+          it "raises the validation error" do
+            expect {
+              account.save!
+            }.to raise_error(Mongoid::Errors::Validations)
+          end
+        end
+      end
+    end
+  end
+
+  context "when overriding the default database", if: non_legacy_server? do
+
+    let(:file) do
+      File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
+    end
+
+    before do
+      Mongoid::Config.load!(file, :test)
+    end
+
+    context "when the override is global" do
+
+      before do
+        Mongoid.override_database(:mongoid_optional)
+      end
+
+      after do
+        Band.delete_all
+        Mongoid.override_database(nil)
+      end
+
+      let!(:band) do
+        Band.create(name: "Tool")
+      end
+
+      it "persists to the overridden database" do
+        Band.mongo_client.with(database: :mongoid_optional) do |sess|
+          expect(sess[:bands].find(name: "Tool")).to_not be_nil
+        end
+      end
+    end
+  end
+end