mongoid 8.0.10 → 8.1.0

data/lib/mongoid/validatable/associated.rb

@@ -15,113 +15,32 @@ module Mongoid
     #
     #     validates_associated :name, :addresses
     #   end
-    class AssociatedValidator < ActiveModel::Validator
-      # Required by `validates_with` so that the validator
-      # gets added to the correct attributes.
-      def attributes
-        options[:attributes]
-      end
+    class AssociatedValidator < ActiveModel::EachValidator
 
-      # Checks that the named associations of the given record
-      # (`attributes`) are valid. This does NOT load the associations
-      # from the database, and will only validate records that are dirty
-      # or unpersisted.
+      # Validates that the associations provided are either all nil or all
+      # valid. If neither is true then the appropriate errors will be added to
+      # the parent document.
       #
-      # If anything is not valid, appropriate errors will be added to
-      # the `document` parameter.
-      #
-      # @param [ Mongoid::Document ] document the document with the
-      #   associations to validate.
-      def validate(document)
-        options[:attributes].each do |attr_name|
-          validate_association(document, attr_name)
-        end
-      end
-
-      private
-
-      # Validates that the given association provided is either nil,
-      # persisted and unchanged, or invalid. Otherwise, the appropriate errors
-      # will be added to the parent document.
+      # @example Validate the association.
+      #   validator.validate_each(document, :name, name)
       #
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The association to validate.
-      def validate_association(document, attribute)
-        # grab the proxy from the instance variable directly; we don't want
-        # any loading logic to run; we just want to see if it's already
-        # been loaded.
-        proxy = document.ivar(attribute)
-        return unless proxy
-
-        # if the variable exists, now we see if it is a proxy, or an actual
-        # document. It might be a literal document instead of a proxy if this
-        # document was created with a Document instance as a provided attribute,
-        # e.g. "Post.new(message: Message.new)".
-        target = proxy.respond_to?(:_target) ? proxy._target : proxy
-
-        # Now, fetch the list of documents from the target. Target may be a
-        # single value, or a list of values, and in the case of HasMany,
-        # might be a rather complex collection. We need to do this without
-        # triggering a load, so it's a bit of a delicate dance.
-        list = get_target_documents(target)
-
-        valid = document.validating do
-          # Now, treating the target as an array, look at each element
-          # and see if it is valid, but only if it has already been
-          # persisted, or changed, and hasn't been flagged for destroy.
-          #
-          # use map.all? instead of just all?, because all? will do short-circuit
-          # evaluation and terminate on the first failed validation.
-          list.map do |value|
-            if value && !value.flagged_for_destroy?
-              value.validated? ? true : value.valid?
-            else
+      # @param [ Object ] value The value of the association.
+      def validate_each(document, attribute, value)
+        begin
+          document.begin_validate
+          valid = Array.wrap(value).collect do |doc|
+            if doc.nil? || doc.flagged_for_destroy?
               true
+            else
+              doc.validated? ? true : doc.valid?
             end
           end.all?
+        ensure
+          document.exit_validate
         end
-
-        document.errors.add(attribute, :invalid) unless valid
-      end
-
-      private
-
-      # Examine the given target object and return an array of
-      # documents (possibly empty) that the target represents.
-      #
-      # @param [ Array | Mongoid::Document | Mongoid::Association::Proxy | HasMany::Enumerable ] target
-      #   the target object to examine.
-      #
-      # @return [ Array<Mongoid::Document> ] the list of documents
-      def get_target_documents(target)
-        if target.respond_to?(:_loaded?)
-          get_target_documents_for_has_many(target)
-        else
-          get_target_documents_for_other(target)
-        end
-      end
-
-      # Returns the list of all currently in-memory values held by
-      # the target. The target will not be loaded.
-      #
-      # @param [ HasMany::Enumerable ] target the target that will
-      #   be examined for in-memory documents.
-      #
-      # @return [ Array<Mongoid::Document> ] the in-memory documents
-      #   held by the target.
-      def get_target_documents_for_has_many(target)
-        [ *target._loaded.values, *target._added.values ]
-      end
-
-      # Returns the target as an array. If the target represents a single
-      # value, it is wrapped in an array.
-      #
-      # @param [ Array | Mongoid::Document | Mongoid::Association::Proxy ] target
-      #   the target to return.
-      #
-      # @return [ Array<Mongoid::Document> ] the target, as an array.
-      def get_target_documents_for_other(target)
-        Array.wrap(target)
+        document.errors.add(attribute, :invalid, **options) unless valid
       end
     end
   end

data/lib/mongoid/validatable/macros.rb

@@ -18,7 +18,7 @@ module Mongoid
       #     validates_associated :name, :addresses
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_associated(*args)
         validates_with(AssociatedValidator, _merge_attributes(args))
       end
@@ -35,7 +35,7 @@ module Mongoid
       #     validates_uniqueness_of :title
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_uniqueness_of(*args)
         validates_with(UniquenessValidator, _merge_attributes(args))
       end
@@ -50,7 +50,7 @@ module Mongoid
       #     validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_format_of(*args)
         validates_with(FormatValidator, _merge_attributes(args))
       end
@@ -65,7 +65,7 @@ module Mongoid
       #     validates_length_of :title, minimum: 100
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_length_of(*args)
         validates_with(LengthValidator, _merge_attributes(args))
       end
@@ -80,7 +80,7 @@ module Mongoid
       #     validates_presence_of :title
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_presence_of(*args)
         validates_with(PresenceValidator, _merge_attributes(args))
       end

data/lib/mongoid/validatable.rb

@@ -37,14 +37,6 @@ module Mongoid
       Threaded.exit_validate(self)
     end
 
-    # Perform a validation within the associated block.
-    def validating
-      begin_validate
-      yield
-    ensure
-      exit_validate
-    end
-
     # Given the provided options, are we performing validations?
     #
     # @example Are we performing validations?
@@ -52,6 +44,8 @@ module Mongoid
     #
     # @param [ Hash ] options The options to check.
     #
+    # @option options [ true | false ] :validate Whether or not to validate.
+    #
     # @return [ true | false ] If we are validating.
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
@@ -137,7 +131,8 @@ module Mongoid
       # @example Validate with a specific validator.
       #   validates_with MyValidator, on: :create
       #
-      # @param [ Class<Array> | Hash ] args The validator classes and options.
+      # @param [ ActiveModel::Validator..., Hash ] *args The validator classes
+      #   and options hash.
       #
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is

data/lib/mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mongoid
-  VERSION = "8.0.10"
+  VERSION = "8.1.0"
 end

data/lib/mongoid/warnings.rb

@@ -23,6 +23,22 @@ module Mongoid
 
     warning :geo_haystack_deprecated, 'The geoHaystack type is deprecated.'
     warning :as_json_compact_deprecated, '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
-    warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type'
+    warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
+    warning :legacy_readonly, 'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
+    warning :use_activesupport_time_zone_deprecated, 'Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will always be true beginning in Mongoid 9.0.'
+    warning :broken_aggregables_deprecated, 'Config option :broken_aggregables is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_alias_handling_deprecated, 'Config option :broken_alias_handling is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_and_deprecated, 'Config option :broken_and is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_scoping_deprecated, 'Config option :broken_scoping is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_updates_deprecated, 'Config option :broken_updates is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :compare_time_by_ms_deprecated, 'Config option :compare_time_by_ms is deprecated. It will always be true beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_attributes_deprecated, 'Config option :legacy_attributes is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_pluck_distinct_deprecated, 'Config option :legacy_pluck_distinct is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_triple_equals_deprecated, 'Config option :legacy_triple_equals is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :object_id_as_json_oid_deprecated, 'Config option :object_id_as_json_oid is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :overwrite_chained_operators_deprecated, 'Config option :overwrite_chained_operators is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :mutable_ids, 'In Mongoid 9.0 the _id field will be immutable. In earlier versions of 8.x, mutating the _id field was supported inconsistently. Prepare your code for 9.0 by setting Mongoid::Config.immutable_ids to true.'
+    warning :mongoid_query_cache, 'In Mongoid 9.0, Mongoid::QueryCache will be removed. Please replace it with Mongo::QueryCache.'
+    warning :mongoid_query_cache_clear, 'In Mongoid 9.0, Mongoid::QueryCache#clear_cache should be replaced it with Mongo::QueryCache#clear.'
   end
 end

data/lib/mongoid.rb

@@ -12,8 +12,10 @@ require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
+require 'concurrent-ruby'
+
 require "mongo"
-require 'mongo/active_support'
+require "mongo/active_support"
 
 require "mongoid/version"
 require "mongoid/deprecable"
@@ -25,6 +27,7 @@ require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
 require "mongoid/warnings"
+require "mongoid/utils"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -58,9 +61,19 @@ module Mongoid
   #     }
   #   end
   #
+  # @example Using a block without an argument. Use `config` inside
+  #   the block to perform variable assignment.
+  #
+  #   Mongoid.configure do
+  #     connect_to("mongoid_test")
+  #
+  #     config.preload_models = true
+  #
   # @return [ Config ] The configuration object.
-  def configure
-    block_given? ? yield(Config) : Config
+  def configure(&block)
+    return Config unless block_given?
+
+    block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
   end
 
   # Convenience method for getting the default client.

data/spec/integration/app_spec.rb

@@ -16,10 +16,6 @@ describe 'Mongoid application tests' do
       skip 'Set APP_TESTS=1 in environment to run application tests'
     end
 
-    if SpecConfig.instance.rails_version < '7.1'
-      skip 'App tests require Rails > 7.0 (see https://stackoverflow.com/questions/79360526)'
-    end
-
     require 'fileutils'
     require 'mrss/child_process_helper'
     require 'open-uri'
@@ -330,7 +326,7 @@ describe 'Mongoid application tests' do
   end
 
   def wait_for_port(port, timeout, process)
-    deadline = Time.now + timeout
+    deadline = Mongoid::Utils.monotonic_time + timeout
     loop do
       begin
         Socket.tcp('localhost', port, nil, nil, connect_timeout: 0.5) do |socket|
@@ -340,7 +336,7 @@ describe 'Mongoid application tests' do
         unless process.alive?
           raise "Process #{process} died while waiting for port #{port}"
         end
-        if Time.now > deadline
+        if Mongoid::Utils.monotonic_time > deadline
           raise
         end
       end

data/spec/integration/associations/has_and_belongs_to_many_spec.rb

@@ -2,28 +2,6 @@
 
 require 'spec_helper'
 
-module HabtmSpec
-  class Page
-    include Mongoid::Document
-    embeds_many :blocks, class_name: 'HabtmSpec::Block'
-  end
-
-  class Block
-    include Mongoid::Document
-    embedded_in :page, class_name: 'HabtmSpec::Page'
-  end
-
-  class ImageBlock < Block
-    has_and_belongs_to_many :attachments, inverse_of: nil, class_name: 'HabtmSpec::Attachment'
-    accepts_nested_attributes_for :attachments
-  end
-
-  class Attachment
-    include Mongoid::Document
-    field :file, type: String
-  end
-end
-
 describe 'has_and_belongs_to_many associations' do
 
   context 'when an anonymous class defines a has_and_belongs_to_many association' do
@@ -40,22 +18,4 @@ describe 'has_and_belongs_to_many associations' do
       expect(klass.new.movies.build).to be_a Movie
     end
   end
-
-  context 'when an embedded has habtm relation' do
-    let(:attachment) { HabtmSpec::Attachment.create!(file: 'foo.jpg') }
-
-    let(:page) { HabtmSpec::Page.create! }
-
-    let(:image_block) do
-      image_block = page.blocks.build({
-        _type: 'HabtmSpec::ImageBlock',
-        attachment_ids: [ attachment.id.to_s ],
-        attachments_attributes: { '1234' => { file: 'bar.jpg', id: attachment.id.to_s } }
-      })
-    end
-
-    it 'does not raise on save' do
-      expect { image_block.save! }.not_to raise_error
-    end
-  end
 end

data/spec/integration/callbacks_spec.rb

@@ -448,23 +448,110 @@ describe 'callbacks integration tests' do
     end
   end
 
-  context 'cascade callbacks' do
-    ruby_version_gte '3.0'
-    config_override :around_callbacks_for_embeds, false
+  context 'saved_change_to_attribute, attribute_before_last_save, will_save_change_to_attribute' do
+    class TestSCTAAndABLSInCallbacks
+      include Mongoid::Document
 
-    let(:book) do
-      Book.new
-    end
+      field :name, type: String
+      field :age, type: Integer
 
-    before do
-      1500.times do
-        book.pages.build
+      set_callback :save, :before do |doc|
+        [:name, :age].each do |attr|
+          saved_change_to_attribute_values_before[attr] += [saved_change_to_attribute(attr)]
+          attribute_before_last_save_values_before[attr] += [attribute_before_last_save(attr)]
+          will_save_change_to_attribute_values_before[attr] += [will_save_change_to_attribute?(attr)]
+        end
+      end
+
+      set_callback :save, :after do |doc|
+        [:name, :age].each do |attr|
+          saved_change_to_attribute_values_after[attr] += [saved_change_to_attribute(attr)]
+          saved_change_to_attribute_q_values_after[attr] += [saved_change_to_attribute?(attr)]
+          attribute_before_last_save_values_after[attr] += [attribute_before_last_save(attr)]
+        end
+      end
+
+      def saved_change_to_attribute_values_before
+        @saved_change_to_attribute_values_before ||= Hash.new do
+          []
+        end
+      end
+
+      def attribute_before_last_save_values_before
+        @attribute_before_last_save_values_before ||= Hash.new do
+          []
+        end
+      end
+
+      def saved_change_to_attribute_values_after
+        @saved_change_to_attribute_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def saved_change_to_attribute_q_values_after
+        @saved_change_to_attribute_q_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def attribute_before_last_save_values_after
+        @attribute_before_last_save_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def will_save_change_to_attribute_values_before
+        @will_save_change_to_attribute_values_before ||= Hash.new do
+          []
+        end
       end
     end
 
-    # https://jira.mongodb.org/browse/MONGOID-5658
-    it 'does not raise SystemStackError' do
-      expect { book.save! }.not_to raise_error(SystemStackError)
+    it 'reproduces ActiveRecord::AttributeMethods::Dirty behavior' do
+      subject = TestSCTAAndABLSInCallbacks.new(name: 'Name 1')
+      subject.save!
+      subject.age = 18
+      subject.save!
+      subject.name = 'Name 2'
+      subject.save!
+
+      expect(subject.saved_change_to_attribute_values_before).to eq(
+        {
+          :name => [nil, [nil, "Name 1"], nil],
+          :age => [nil, nil, [nil, 18]],
+        }
+      )
+      expect(subject.saved_change_to_attribute_values_after).to eq(
+        {
+          :name => [[nil, "Name 1"], nil, ["Name 1", "Name 2"]],
+          :age => [nil, [nil, 18], nil],
+        }
+      )
+      expect(subject.saved_change_to_attribute_q_values_after).to eq(
+        {
+          :name => [true, false, true],
+          :age => [false, true, false],
+        }
+      )
+      expect(subject.attribute_before_last_save_values_before).to eq(
+        {
+          :name => [nil, nil, "Name 1"],
+          :age => [nil, nil, nil]
+        }
+      )
+      expect(subject.attribute_before_last_save_values_after).to eq(
+        {
+          :name => [nil, "Name 1", "Name 1"],
+          :age => [nil, nil, 18]
+        }
+      )
+      expect(subject.will_save_change_to_attribute_values_before).to eq(
+        {
+          :name => [true, false, true],
+          :age => [false, true, false]
+        }
+      )
     end
   end
 

data/spec/integration/discriminator_key_spec.rb

@@ -81,8 +81,9 @@ describe "#discriminator_key" do
     end
 
     context "before class creation" do
+      config_override :discriminator_key, "test"
+
       before do
-        Mongoid.discriminator_key = "test"
 
         class PreGlobalIntDiscriminatorParent
           include Mongoid::Document
@@ -93,7 +94,6 @@ describe "#discriminator_key" do
       end
 
       after do
-        Mongoid.discriminator_key = "_type"
         Object.send(:remove_const, :PreGlobalIntDiscriminatorParent)
         Object.send(:remove_const, :PreGlobalIntDiscriminatorChild)
       end
@@ -336,9 +336,9 @@ describe "#discriminator_key" do
     end
 
     context "Example 3" do
-      before do
-        Mongoid.discriminator_key = "shape_type"
+      config_override :discriminator_key, "shape_type"
 
+      before do
         class Example3Shape
           include Mongoid::Document
           field :x, type: Integer
@@ -358,7 +358,6 @@ describe "#discriminator_key" do
       end
 
       after do
-        Mongoid.discriminator_key = "_type"
         Object.send(:remove_const, :Example3Shape)
         Object.send(:remove_const, :Example3Circle)
         Object.send(:remove_const, :Example3Rectangle)

data/spec/integration/i18n_fallbacks_spec.rb

@@ -3,11 +3,12 @@
 require 'spec_helper'
 
 describe 'i18n fallbacks' do
-  with_i18n_fallbacks
+  require_fallbacks
 
   context 'when fallbacks are enabled with a locale list' do
+    with_default_i18n_configs
+
     before do
-      I18n.default_locale = :en
       I18n.fallbacks[:de] = [ :en ]
     end
 

data/spec/mongoid/association/eager_spec.rb

@@ -14,36 +14,14 @@ describe Mongoid::Association::EagerLoadable do
       Mongoid::Contextual::Mongo.new(criteria)
     end
 
-    let(:association_host) { Account }
-
     let(:inclusions) do
       includes.map do |key|
-        association_host.reflect_on_association(key)
+        Account.reflect_on_association(key)
       end
     end
 
     let(:doc) { criteria.first }
 
-    context 'when root is an STI subclass' do
-      # Driver has_one Vehicle
-      # Vehicle belongs_to Driver
-      # Truck is a Vehicle
-
-      before do
-        Driver.create!(vehicle: Truck.new)
-      end
-
-      let(:criteria) { Truck.all }
-      let(:includes) { %i[ driver ] }
-      let(:association_host) { Truck }
-
-      it 'preloads the driver' do
-        expect(doc.ivar(:driver)).to be false
-        context.preload(inclusions, [ doc ])
-        expect(doc.ivar(:driver)).to be == Driver.first
-      end
-    end
-
     context "when belongs_to" do
 
       let!(:account) do
@@ -64,7 +42,7 @@ describe Mongoid::Association::EagerLoadable do
       it "preloads the parent" do
         expect(doc.ivar(:person)).to be false
         context.preload(inclusions, [doc])
-        expect(doc.ivar(:person)).to be == person
+        expect(doc.ivar(:person)).to eq(doc.person)
       end
     end
 

data/spec/mongoid/association/embedded/embedded_in/proxy_spec.rb

@@ -616,4 +616,31 @@ describe Mongoid::Association::Embedded::EmbeddedIn::Proxy do
       end
     end
   end
+
+  context "when assigning a hash" do
+    let(:building_address) { BuildingAddress.new }
+
+    before do
+      building_address.building = { name: "Chrysler" }
+    end
+
+    it "creates the objects correctly" do
+      expect(building_address.building).to be_a(Building)
+      expect(building_address.building.name).to eq("Chrysler")
+    end
+  end
+
+  context "when replacing an association with a hash" do
+    let(:building_address) { BuildingAddress.new }
+
+    before do
+      building_address.building = { name: "Chrysler" }
+      building_address.building = { name: "Empire State" }
+    end
+
+    it "creates the objects correctly" do
+      expect(building_address.building).to be_a(Building)
+      expect(building_address.building.name).to eq("Empire State")
+    end
+  end
 end