mongoid 7.2.1 → 9.0.0

data/spec/support/constraints.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Constraints
   RAILS_VERSION = ActiveSupport.version.to_s.split('.')[0..1].join('.').freeze
@@ -28,6 +28,30 @@ module Constraints
     Mongo::VERSION.split('.')[0...precision].map(&:to_i)
   end
 
+  def min_bson_version(version)
+    required_version = version.split('.').map(&:to_i)
+    actual_version = bson_version(required_version.length)
+    before(:all) do
+      if (actual_version <=> required_version) < 0
+        skip "bson-ruby version #{version} or higher is required"
+      end
+    end
+  end
+
+  def max_bson_version(version)
+    required_version = version.split('.').map(&:to_i)
+    actual_version = bson_version(required_version.length)
+    before(:all) do
+      if (actual_version <=> required_version) > 0
+        skip "bson-ruby version #{version} or lower is required"
+      end
+    end
+  end
+
+  def bson_version(precision)
+    BSON::VERSION.split('.')[0...precision].map(&:to_i)
+  end
+
   def min_rails_version(version)
     unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"

data/spec/support/crypt/models.rb

@@ -0,0 +1,50 @@
+# rubocop:todo all
+module Crypt
+  class Patient
+    include Mongoid::Document
+
+    encrypt_with key_id: "grolrnFVSSW9Gq04Q87R9Q=="
+
+    field :code, type: String
+    field :medical_records, type: Array, encrypt: { deterministic: false}
+    field :blood_type, type: String, encrypt: {
+      deterministic: false,
+      key_name_field: :blood_type_key_name
+    }
+    field :ssn, type: Integer, encrypt: { deterministic: true }
+    field :blood_type_key_name, type: String
+
+    embeds_one :insurance, class_name: "Crypt::Insurance"
+  end
+
+  class Insurance
+    include Mongoid::Document
+
+    field :policy_number, type: Integer, encrypt: { deterministic: true }
+    embedded_in :patient, class_name: "Crypt::Patient"
+  end
+
+  class User
+    include Mongoid::Document
+
+    field :name, type: String, encrypt: {
+      key_id: "grolrnFVSSW9Gq04Q87R9Q==",
+      deterministic: false
+    }
+    field :email, type: String, encrypt: {
+      key_id: "S34mE/HhSFSym3yErpER6Q==",
+      deterministic: true
+    }
+  end
+
+  class Car
+    include Mongoid::Document
+
+    store_in database: 'vehicles'
+
+    encrypt_with key_id: "grolrnFVSSW9Gq04Q87R9Q==", deterministic: true
+
+    field :vin, type: String, encrypt: true
+    field :make, type: String
+  end
+end

data/spec/support/crypt.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  # This module includes helpers for testing encryption.
+  module Crypt
+
+    shared_context 'with encryption' do
+      let(:mongocryptd_port) do
+        if ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'] &&
+          !ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'].empty?
+        then
+          ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'].to_i
+        else
+          27020
+        end
+      end
+
+      let(:extra_options) do
+        {
+          mongocryptd_spawn_args: ["--port=#{mongocryptd_port}"],
+          mongocryptd_uri: "mongodb://localhost:#{mongocryptd_port}",
+        }
+      end
+
+      let(:crypt_shared_lib_path) do
+        ENV['MONGO_RUBY_DRIVER_CRYPT_SHARED_LIB_PATH']
+      end
+
+      let(:key_vault_client) do
+        Mongo::Client.new(SpecConfig.instance.addresses, database: key_vault_database)
+      end
+
+      let(:key_vault_database) do
+        'encryption'
+      end
+
+      let(:key_vault_collection) do
+        '__keyVault'
+      end
+
+      let(:key_vault_namespace) do
+        "#{key_vault_database}.#{key_vault_collection}"
+      end
+
+      let(:local_master_key) do
+        'A' * 96
+      end
+
+      let(:kms_providers) do
+        {
+          local: {
+            key: local_master_key
+          }
+        }
+      end
+
+      let(:key_alt_name) do
+        'mongoid_test_key'
+      end
+
+      let(:client_encryption) do
+        Mongo::ClientEncryption.new(
+          key_vault_client,
+          key_vault_namespace: key_vault_namespace,
+          kms_providers: kms_providers
+        )
+      end
+
+      let(:data_key_id) do
+        if (data_key = client_encryption.get_key_by_alt_name(key_alt_name))
+          Base64.encode64(data_key['_id'].data)
+        else
+          key_id = client_encryption.create_data_key('local', key_alt_names: [key_alt_name])
+          Base64.encode64(key_id.data).strip
+        end
+      end
+    end
+  end
+end

data/spec/support/expectations.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Expectations

data/spec/support/feature_sandbox.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# A helper utility for allowing features to be loaded and constants defined
+# inside a sandbox, where they can be unloaded and undefined when finished.
+#
+# @example Quarantining a block of code.
+#   FeatureSandbox.quarantine do
+#      require "support/rails_mock"
+#      expect(defined?(Rails)).to be == "constant"
+#   end
+#   expect(defined?(Rails)).to be_nil
+module FeatureSandbox
+  extend self
+
+  # Initiates the quarantine by noting the current state of the top-level
+  # constants, the $LOADED_FEATURES array, and the $LOAD_PATH.
+  #
+  # @return Hash The current state of the environment.
+  def start_quarantine
+    { constants: Object.constants.dup,
+      features: $LOADED_FEATURES.dup,
+      load_path: $LOAD_PATH.dup }
+  end
+
+  # Terminates the quarantine indicated by the given state, by rolling back
+  # changes made since the state was created.
+  #
+  # @param [ Hash ] state The state object to roll the environment back to.
+  def end_quarantine(state)
+    restore_load_path(state[:load_path])
+    unload_features($LOADED_FEATURES - state[:features])
+    unload_constants(Object, Object.constants - state[:constants])
+  end
+
+  # A convenience method for starting a quarantine, yielding to a block, and
+  # then ending the quarantine when the block finishes.
+  #
+  # @yield The block will be executed within the quarantine, with all changes
+  #    to state rolled back upon completion.
+  def quarantine
+    state = start_quarantine
+    yield
+  ensure
+    end_quarantine(state)
+  end
+
+  private
+
+  def restore_load_path(list)
+    $LOAD_PATH.replace(list)
+  end
+
+  def unload_features(list)
+    list.each do |path|
+      $LOADED_FEATURES.delete(path)
+    end
+  end
+
+  def unload_constants(parent, list)
+    list.each do |name|
+      obj = parent.const_get(name)
+      if obj.is_a?(Module) && obj.constants(false).any?
+        unload_constants(obj, obj.constants(false))
+      end
+
+      Mongoid.deregister_model(obj) if obj.is_a?(Mongoid::Document)
+
+      parent.send(:remove_const, name)
+    end
+  end
+end

data/spec/support/helpers.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 module Helpers
   # Reloads the specified model class.
   #

data/spec/support/immutable_ids.rb

@@ -0,0 +1,119 @@
+# rubocop:todo all
+module Mongoid
+  module ImmutableIds
+    def immutable_id_examples_as(name)
+      shared_examples_for name do
+        shared_examples 'a persisted document' do
+          it 'should disallow _id to be updated' do
+            expect { invoke_operation! }
+              .to raise_error(Mongoid::Errors::ImmutableAttribute)
+          end
+    
+          context 'when immutable_ids is false' do
+            before { Mongoid::Config.immutable_ids = false }
+            after { Mongoid::Config.immutable_ids = true }
+
+            it 'should ignore the change and issue a warning' do
+              expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+              expect { invoke_operation! }.not_to raise_error
+              expect(id_is_unchanged).not_to be legacy_behavior_expects_id_to_change
+            end
+          end
+
+          context 'when id is set to the existing value' do
+            let(:new_id_value) { object._id }
+
+            it 'should allow the update to proceed' do
+              expect { invoke_operation! }
+                .not_to raise_error
+            end
+          end
+        end
+
+        context 'when the field is _id' do
+          let(:new_id_value) { 1234 }
+
+          context 'when the document is top-level' do    
+            let(:legacy_behavior_expects_id_to_change) { false }
+
+            context 'when the document is new' do
+              let(:object) { Person.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(object.reload._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { Person.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { Person.exists?(original_id) }
+    
+              it_behaves_like 'a persisted document'
+            end
+          end
+    
+          context 'when the document is embedded' do
+            let(:parent) { Person.create }
+            let(:legacy_behavior_expects_id_to_change) { true }
+
+            context 'when the document is new' do
+              let(:object) { parent.favorites.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(parent.reload.favorites.first._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { parent.favorites.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { parent.favorites.where(_id: original_id).exists? }
+      
+              it_behaves_like 'a persisted document'
+
+              context 'updating embeds_one via parent' do
+                context 'when immutable_ids is false' do
+                  before { Mongoid::Config.immutable_ids = false }
+                  after { Mongoid::Config.immutable_ids = true }
+
+                  it 'should ignore the change' do
+                    expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }.not_to raise_error
+                    expect(parent.reload.pet._id.to_s).to be == original_id.to_s
+                  end
+                end
+
+                context 'when immutable_ids is true' do
+                  before { expect(Mongoid::Config.immutable_ids).to be true }
+
+                  it 'should raise an exception' do
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }
+                      .to raise_error(Mongoid::Errors::ImmutableAttribute)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/macros.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Macros
+
     def use_spec_mongoid_config
       around do |example|
         config_path = File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
@@ -17,5 +18,110 @@ module Mongoid
         end
       end
     end
+
+    def config_override(key, value)
+      around do |example|
+        existing = Mongoid.send(key)
+
+        Mongoid.send("#{key}=", value)
+
+        example.run
+
+        Mongoid.send("#{key}=", existing)
+      end
+    end
+
+    def with_config_values(key, *values, &block)
+      values.each do |value|
+        context "when #{key} is #{value}" do
+          config_override key, value
+
+          class_exec(value, &block)
+        end
+      end
+    end
+
+    def driver_config_override(key, value)
+      around do |example|
+        existing = Mongo.send(key)
+
+        Mongo.send("#{key}=", value)
+
+        example.run
+
+        Mongo.send("#{key}=", existing)
+      end
+    end
+
+    def with_driver_config_values(key, *values, &block)
+      values.each do |value|
+        context "when #{key} is #{value}" do
+          driver_config_override key, value
+
+          class_exec(value, &block)
+        end
+      end
+    end
+
+    def restore_config_clients
+      around do |example|
+        # Duplicate the config because some tests mutate it.
+        old_config = Mongoid::Config.clients.dup
+        example.run
+        Mongoid::Config.send(:clients=, old_config)
+      end
+    end
+
+    def query_cache_enabled
+      around do |example|
+        Mongo::QueryCache.cache do
+          example.run
+        end
+      end
+    end
+
+    def override_query_cache(enabled)
+      around do |example|
+        cache_enabled = Mongo::QueryCache.enabled?
+        Mongo::QueryCache.enabled = enabled
+        example.run
+        Mongo::QueryCache.enabled = cache_enabled
+      end
+    end
+
+    # Override the global persistence context.
+    #
+    # @param [ :client, :database ] component The component to override.
+    # @param [ Object ] value The value to override to.
+    def persistence_context_override(component, value)
+      around do |example|
+        meth = "#{component}_override"
+        old_value = Mongoid::Threaded.send(meth)
+        Mongoid::Threaded.send("#{meth}=", value)
+        example.run
+        Mongoid::Threaded.send("#{meth}=", old_value)
+      end
+    end
+
+    def time_zone_override(time_zone)
+      around do |example|
+        Time.use_zone(time_zone) { example.run }
+      end
+    end
+
+    def with_default_i18n_configs
+      around do |example|
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+        example.run
+      ensure
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+      end
+    end
   end
 end

data/spec/support/models/account.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Account
   include Mongoid::Document
@@ -7,7 +7,7 @@ class Account
   field :_id, type: String, overwrite: true, default: ->{ name.try(:parameterize) }
 
   field :number, type: String
-  field :balance, type: String
+  field :balance, type: Integer
   field :nickname, type: String
   field :name, type: String
   field :balanced, type: Mongoid::Boolean, default: ->{ balance? ? true : false }

data/spec/support/models/acolyte.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Acolyte
   include Mongoid::Document

data/spec/support/models/actor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Actor
   include Mongoid::Document

data/spec/support/models/actress.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Actress < Actor
 end

data/spec/support/models/address.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Address
   include Mongoid::Document
@@ -27,6 +27,8 @@ class Address
   field :s, type: String, as: :suite
   field :name, localize: true
 
+  alias_attribute :n, :name
+
   embeds_many :locations, validate: false
   embeds_one :code, validate: false
   embeds_one :target, as: :targetable, validate: false
@@ -78,5 +80,9 @@ class Address
     def streets
       all.map(&:street)
     end
+
+    def city_and_state(city:, state:)
+      where(city: city, state: state)
+    end
   end
 end

data/spec/support/models/address_component.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class AddressComponent
   include Mongoid::Document

data/spec/support/models/address_number.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class AddressNumber
   include Mongoid::Document

data/spec/support/models/agency.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Agency
   include Mongoid::Document

data/spec/support/models/agent.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Agent
   include Mongoid::Document

data/spec/support/models/album.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Album
   include Mongoid::Document

data/spec/support/models/alert.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Alert
   include Mongoid::Document

data/spec/support/models/animal.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Animal
   include Mongoid::Document

data/spec/support/models/answer.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Answer
   include Mongoid::Document

data/spec/support/models/appointment.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Appointment
   include Mongoid::Document

data/spec/support/models/armrest.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Armrest
   include Mongoid::Document

data/spec/support/models/array_field.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class ArrayField
   include Mongoid::Document

data/spec/support/models/article.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Article
   include Mongoid::Document

data/spec/support/models/artist.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 class Artist
   include Mongoid::Document
@@ -11,6 +11,7 @@ class Artist
   embeds_many :songs, before_add: [ :before_add_song, Proc.new { |artist, song| song.before_add_called = true } ], before_remove: :before_remove_song
   embeds_many :labels, after_add: :after_add_label, after_remove: :after_remove_label
   has_many :albums, dependent: :destroy, before_add: [:before_add_album, Proc.new { |artist, album| album.before_add_called = true} ], after_add: :after_add_album, before_remove: :before_remove_album, after_remove: :after_remove_album
+  belongs_to :band
 
   before_create :before_create_stub
   after_create :create_songs
@@ -19,6 +20,7 @@ class Artist
   before_update :before_update_stub
 
   protected
+
   def before_create_stub
     true
   end
@@ -86,5 +88,4 @@ class Artist
   def after_remove_album(album)
     @after_remove_referenced_called = true
   end
-
 end