mongoid 9.0.11 → 9.1.1

data/spec/mongoid/errors/no_client_database_spec.rb

@@ -1,32 +1,58 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoClientDatabase do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new(:analytics, { hosts: [ "127.0.0.1:27017" ] })
+      described_class.new(:analytics, { hosts: [ '127.0.0.1:27017' ] })
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "No database provided for client configuration: :analytics."
+        'No database provided for client configuration: :analytics.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Each client configuration must provide a database so Mongoid"
+        'Each client configuration must provide a database so Mongoid'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "If configuring via a mongoid.yml, ensure that within your :analytics"
+        'If configuring via a mongoid.yml, ensure that within your :analytics'
       )
     end
+
+    context 'when the config contains sensitive values' do
+      let(:error) do
+        described_class.new(
+          :analytics,
+          {
+            hosts: [ '127.0.0.1:27017' ],
+            password: 's3cr3t',
+            options: {
+              auto_encryption_options: {
+                kms_providers: {
+                  aws: { access_key_id: 'AKIAEXAMPLE', secret_access_key: 'aws-secret' }
+                }
+              }
+            }
+          }
+        )
+      end
+
+      it 'redacts the password value' do
+        expect(error.message).not_to include('s3cr3t')
+      end
+
+      it 'redacts auto_encryption_options entirely' do
+        expect(error.message).not_to include('kms_providers')
+        expect(error.message).not_to include('aws-secret')
+        expect(error.message).not_to include('AKIAEXAMPLE')
+      end
+    end
   end
 end

data/spec/mongoid/errors/no_client_hosts_spec.rb

@@ -1,32 +1,55 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoClientHosts do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new(:analytics, { database: "mongoid_test" })
+      described_class.new(:analytics, { database: 'mongoid_test' })
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "No hosts provided for client configuration: :analytics."
+        'No hosts provided for client configuration: :analytics.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Each client configuration must provide hosts so Mongoid"
+        'Each client configuration must provide hosts so Mongoid'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "If configuring via a mongoid.yml, ensure that within your :analytics"
+        'If configuring via a mongoid.yml, ensure that within your :analytics'
       )
     end
+
+    context 'when the config contains sensitive values' do
+      let(:error) do
+        described_class.new(
+          :analytics,
+          {
+            database: 'mongoid_test',
+            password: 's3cr3t',
+            options: {
+              auto_encryption_options: {
+                kms_providers: { local: { key: 'A' * 96 } }
+              }
+            }
+          }
+        )
+      end
+
+      it 'redacts the password value' do
+        expect(error.message).not_to include('s3cr3t')
+      end
+
+      it 'redacts auto_encryption_options entirely' do
+        expect(error.message).not_to include('kms_providers')
+        expect(error.message).not_to include('A' * 96)
+      end
+    end
   end
 end

data/spec/mongoid/errors/no_clients_config_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoClientsConfig do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "No clients configuration provided."
+        'No clients configuration provided.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
         "Mongoid's configuration requires that you provide details"
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Double check your mongoid.yml to make sure that you have"
+        'Double check your mongoid.yml to make sure that you have'
       )
     end
   end

data/spec/mongoid/errors/no_environment_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoEnvironment do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Mongoid could not determine the environment"
+        'Mongoid could not determine the environment'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "it was not specified in any of the following locations"
+        'it was not specified in any of the following locations'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Please ensure an environment is set"
+        'Please ensure an environment is set'
       )
     end
   end

data/spec/mongoid/errors/no_map_reduce_output_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoMapReduceOutput do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(query: {})
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "No output location was specified for the map/reduce operation."
+        'No output location was specified for the map/reduce operation.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "When executing a map/reduce, you must provide the output location"
+        'When executing a map/reduce, you must provide the output location'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Provide the location that the output of the operation"
+        'Provide the location that the output of the operation'
       )
     end
   end

data/spec/mongoid/errors/no_metadata_spec.rb

@@ -1,26 +1,23 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'spec_helper'
 
 describe Mongoid::Errors::NoMetadata do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(Address)
     end
 
-    it "contains the problem in the message" do
-      expect(error.message).to include("Metadata not found for document of type Address.")
+    it 'contains the problem in the message' do
+      expect(error.message).to include('Metadata not found for document of type Address.')
     end
 
-    it "contains the summary in the message" do
-      expect(error.message).to include("Mongoid sets the metadata of an association on the")
+    it 'contains the summary in the message' do
+      expect(error.message).to include('Mongoid sets the metadata of an association on the')
     end
 
-    it "contains the resolution in the message" do
-      expect(error.message).to include("Ensure that your associations on the Address model")
+    it 'contains the resolution in the message' do
+      expect(error.message).to include('Ensure that your associations on the Address model')
     end
   end
 end

data/spec/mongoid/errors/no_parent_spec.rb

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::NoParent do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(Address)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Cannot persist embedded document Address without a parent document."
+        'Cannot persist embedded document Address without a parent document.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "If the document is embedded, in order to be persisted it must"
+        'If the document is embedded, in order to be persisted it must'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
         "Ensure that you've set the parent association if instantiating"
       )

data/spec/mongoid/errors/readonly_association_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Mongoid::Errors::ReadonlyAssociation do
+  let(:owner_class) do
+    Class.new do
+      def self.to_s
+        'SomeOwner'
+      end
+    end
+  end
+
+  let(:association) do
+    double(name: :patients, options: { through: :appointments })
+  end
+
+  describe '#message' do
+    it 'names the association' do
+      error = described_class.new(owner_class, association)
+      expect(error.message).to include(':patients')
+    end
+
+    it 'names the owner class' do
+      error = described_class.new(owner_class, association)
+      expect(error.message).to include('SomeOwner')
+    end
+
+    it 'names the intermediate association' do
+      error = described_class.new(owner_class, association)
+      expect(error.message).to include(':appointments')
+    end
+  end
+end

data/spec/mongoid/errors/readonly_attribute_spec.rb

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::ReadonlyAttribute do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new(:title, "mr")
+      described_class.new(:title, 'mr')
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
         "Attempted to set the readonly attribute 'title' with the value: mr."
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Attributes flagged as readonly via Model.attr_readonly can only"
+        'Attributes flagged as readonly via Model.attr_readonly can only'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
         "Don't define 'title' as readonly, or do not attempt to update"
       )

data/spec/mongoid/errors/readonly_document_spec.rb

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::ReadonlyDocument do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(Band)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
         "Attempted to persist a readonly document of class 'Band'."
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Documents that are marked readonly cannot be persisted"
+        'Documents that are marked readonly cannot be persisted'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
         "Don't attempt to persist documents that are flagged as readonly."
       )

data/spec/mongoid/errors/scope_overwrite_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::ScopeOverwrite do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new("Person", "scope")
+      described_class.new('Person', 'scope')
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Cannot create scope :scope, because of existing method Person.scope."
+        'Cannot create scope :scope, because of existing method Person.scope.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "When defining a scope that conflicts with a method that already exists"
+        'When defining a scope that conflicts with a method that already exists'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Change the name of the scope so it does not conflict with the already"
+        'Change the name of the scope so it does not conflict with the already'
       )
     end
   end

data/spec/mongoid/errors/too_many_nested_attribute_records_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::TooManyNestedAttributeRecords do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new("favorites", 5)
+      described_class.new('favorites', 5)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Accepting nested attributes for favorites is limited to 5 documents."
+        'Accepting nested attributes for favorites is limited to 5 documents.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "More documents were sent to be processed than the allowed limit."
+        'More documents were sent to be processed than the allowed limit.'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "The limit is set as an option to the macro, for example:"
+        'The limit is set as an option to the macro, for example:'
       )
     end
   end

data/spec/mongoid/errors/unknown_attribute_spec.rb

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::UnknownAttribute do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(Person, :gender)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
         "Attempted to set a value for 'gender' which is not allowed on"
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
         "Person#gender= was called but there is no 'gender'"
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
         "Define the field 'gender' in Person, or include"
       )

data/spec/mongoid/errors/unsaved_document_spec.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::UnsavedDocument do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:base) do
       Person.new
     end
@@ -19,21 +16,21 @@ describe Mongoid::Errors::UnsavedDocument do
       described_class.new(base, document)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Attempted to save Post before the parent Person."
+        'Attempted to save Post before the parent Person.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "You cannot call create or create! through the association"
+        'You cannot call create or create! through the association'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Make sure to only use create or create!"
+        'Make sure to only use create or create!'
       )
     end
   end

data/spec/mongoid/errors/unsupported_javascript_spec.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::UnsupportedJavascript do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
-      described_class.new(Address, "this.street == null")
+      described_class.new(Address, 'this.street == null')
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Executing Javascript $where selector on an embedded criteria is not supported"
+        'Executing Javascript $where selector on an embedded criteria is not supported'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Mongoid only supports providing a hash of arguments to #where"
+        'Mongoid only supports providing a hash of arguments to #where'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Please provide a standard hash to #where when the criteria"
+        'Please provide a standard hash to #where when the criteria'
       )
     end
   end