mongoid 8.1.3 → 8.1.11

data/lib/mongoid/validatable/associated.rb

@@ -15,32 +15,113 @@ module Mongoid
     #
     #     validates_associated :name, :addresses
     #   end
-    class AssociatedValidator < ActiveModel::EachValidator
+    class AssociatedValidator < ActiveModel::Validator
+      # Required by `validates_with` so that the validator
+      # gets added to the correct attributes.
+      def attributes
+        options[:attributes]
+      end
 
-      # 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.
+      # 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.
       #
-      # @example Validate the association.
-      #   validator.validate_each(document, :name, name)
+      # 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.
       #
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The association to validate.
-      # @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
+      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.persisted? || value.changed?)
+              value.validated? ? true : value.valid?
             else
-              doc.validated? ? true : doc.valid?
+              true
             end
           end.all?
-        ensure
-          document.exit_validate
         end
-        document.errors.add(attribute, :invalid, **options) unless valid
+
+        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)
       end
     end
   end

data/lib/mongoid/validatable/macros.rb

@@ -84,6 +84,21 @@ module Mongoid
       def validates_presence_of(*args)
         validates_with(PresenceValidator, _merge_attributes(args))
       end
+
+      # Validates whether or not a field contains a numeric value.
+      #
+      # @example
+      #   class Person
+      #     include Mongoid::Document
+      #     field :cost
+      #
+      #     validates_numericality_of :cost
+      #   end
+      #
+      # @param [ Object... ] *args The names of the field(s) to validate.
+      def validates_numericality_of(*args)
+        validates_with(NumericalityValidator, _merge_attributes(args))
+      end
     end
   end
 end

data/lib/mongoid/validatable/numericality.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Validatable
+    # A specialization of the ActiveModel numericality validator, which adds
+    # logic to recognize and accept BSON::Decimal128 as a number.
+    class NumericalityValidator < ActiveModel::Validations::NumericalityValidator
+      private
+
+      # Ensure that BSON::Decimal128 is treated as a BigDecimal during the
+      # validation step.
+      def prepare_value_for_validation(value, record, attr_name)
+        result = super
+
+        result.is_a?(BSON::Decimal128) ? result.to_big_decimal : result
+      end
+    end
+  end
+end

data/lib/mongoid/validatable.rb

@@ -5,6 +5,7 @@ require "mongoid/validatable/localizable"
 require "mongoid/validatable/associated"
 require "mongoid/validatable/format"
 require "mongoid/validatable/length"
+require "mongoid/validatable/numericality"
 require "mongoid/validatable/queryable"
 require "mongoid/validatable/presence"
 require "mongoid/validatable/uniqueness"
@@ -37,6 +38,14 @@ 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?

data/lib/mongoid/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 module Mongoid
-  VERSION = "8.1.3"
+  # The current version of Mongoid
+  #
+  # Note that this file is automatically updated via `rake candidate:create`.
+  # Manual changes to this file will be overwritten by that rake task.
+  VERSION = '8.1.11'
 end

data/spec/integration/app_spec.rb

@@ -16,6 +16,10 @@ 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'
@@ -26,6 +30,8 @@ describe 'Mongoid application tests' do
   context 'demo application' do
     context 'sinatra' do
       it 'runs' do
+        skip 'https://jira.mongodb.org/browse/MONGOID-5826'
+
         clone_application(
           'https://github.com/mongoid/mongoid-demo',
           subdir: 'sinatra-minimal',
@@ -45,6 +51,8 @@ describe 'Mongoid application tests' do
 
     context 'rails-api' do
       it 'runs' do
+        skip 'https://jira.mongodb.org/browse/MONGOID-5826'
+
         clone_application(
           'https://github.com/mongoid/mongoid-demo',
           subdir: 'rails-api',
@@ -87,6 +95,12 @@ describe 'Mongoid application tests' do
   end
 
   context 'new application - rails' do
+    before(:all) do
+      if SpecConfig.instance.rails_version < '7.1'
+        skip '`rails new` with rails < 7.1 fails because modern concurrent-ruby removed logger dependency'
+      end
+    end
+
     it 'creates' do
       install_rails
 
@@ -95,7 +109,7 @@ describe 'Mongoid application tests' do
         check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
 
         Dir.chdir('mongoid-test') do
-          adjust_app_gemfile
+          adjust_app_gemfile(add_sprockets: SpecConfig.instance.rails_version != '8.0')
           check_call(%w(bundle install), env: clean_env)
 
           check_call(%w(rails g model post), env: clean_env)
@@ -117,7 +131,7 @@ describe 'Mongoid application tests' do
         check_call(%w(rails new mongoid-test-config --skip-spring --skip-active-record), env: clean_env)
 
         Dir.chdir('mongoid-test-config') do
-          adjust_app_gemfile
+          adjust_app_gemfile(add_sprockets: SpecConfig.instance.rails_version != '8.0')
           check_call(%w(bundle install), env: clean_env)
 
           mongoid_config_file = File.join(TMP_BASE,'mongoid-test-config/config/mongoid.yml')
@@ -139,7 +153,7 @@ describe 'Mongoid application tests' do
     if (rails_version = SpecConfig.instance.rails_version) == 'master'
     else
       check_call(%w(gem list))
-      check_call(%w(gem install rails --no-document -v) + ["~> #{rails_version}.0"])
+      check_call(%w(gem install rails --no-document --force -v) + ["~> #{rails_version}.0"])
     end
   end
 
@@ -205,7 +219,7 @@ describe 'Mongoid application tests' do
       FileUtils.rm_rf(File.basename(repo_url))
       check_call(%w(git clone) + [repo_url])
       Dir.chdir(File.join(*[File.basename(repo_url), subdir].compact)) do
-        adjust_app_gemfile
+        adjust_app_gemfile(add_sprockets: false)
         adjust_rails_defaults
         check_call(%w(bundle install), env: clean_env)
         puts `git diff`
@@ -262,7 +276,7 @@ describe 'Mongoid application tests' do
     end
   end
 
-  def adjust_app_gemfile(rails_version: SpecConfig.instance.rails_version)
+  def adjust_app_gemfile(rails_version: SpecConfig.instance.rails_version, add_sprockets: true)
     remove_bundler_req
 
     gemfile_lines = IO.readlines('Gemfile')
@@ -280,12 +294,17 @@ describe 'Mongoid application tests' do
         gemfile_lines << "gem 'rails', '~> #{rails_version}.0'\n"
       end
     end
+    gemfile_lines << "gem 'sprockets-rails'\n" if add_sprockets
     File.open('Gemfile', 'w') do |f|
       f << gemfile_lines.join
     end
   end
 
   def adjust_rails_defaults(rails_version: SpecConfig.instance.rails_version)
+    if !rails_version.match?(/^\d+\.\d+$/)
+      # This must be pre-release version, we trim it
+      rails_version = rails_version.split('.')[0..1].join('.')
+    end
     if File.exist?('config/application.rb')
       lines = IO.readlines('config/application.rb')
       lines.each do |line|

data/spec/integration/associations/embeds_one_spec.rb

@@ -3,8 +3,7 @@
 require 'spec_helper'
 
 describe 'embeds_one associations' do
-
-  context 're-associating the same object' do
+  context 'when re-associating the same object' do
     context 'with dependent: destroy' do
       let(:canvas) do
         Canvas.create!(palette: Palette.new)
@@ -16,7 +15,7 @@ describe 'embeds_one associations' do
         canvas.palette = canvas.palette
         canvas.save!
         canvas.reload
-        canvas.palette.should == palette
+        expect(canvas.palette).to eq palette
       end
     end
   end
@@ -30,12 +29,33 @@ describe 'embeds_one associations' do
     end
 
     it 'loads the association correctly' do
-      expect { klass }.to_not raise_error
-      expect { klass.new.address }.to_not raise_error
+      expect { klass }.not_to raise_error
+      expect { klass.new.address }.not_to raise_error
       instance = klass.new
       address = Address.new
       instance.address = address
       expect(instance.address).to eq address
     end
   end
+
+  context 'when parent is persisted' do
+    let!(:person) do
+      Person.create!
+    end
+
+    context 'when assigning the new child' do
+      context 'when assigning an attribute to the child' do
+        before do
+          # person.reload
+          person.name = Name.new
+          person.name.first_name = 'Dmitry'
+          person.save!
+        end
+
+        it 'persists the child' do
+          expect(person.reload.name.first_name).to eq 'Dmitry'
+        end
+      end
+    end
+  end
 end

data/spec/integration/associations/has_and_belongs_to_many_spec.rb

@@ -2,6 +2,28 @@
 
 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
@@ -18,4 +40,22 @@ 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/mongoid/association/eager_spec.rb

@@ -14,14 +14,36 @@ describe Mongoid::Association::EagerLoadable do
       Mongoid::Contextual::Mongo.new(criteria)
     end
 
+    let(:association_host) { Account }
+
     let(:inclusions) do
       includes.map do |key|
-        Account.reflect_on_association(key)
+        association_host.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
@@ -42,7 +64,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 eq(doc.person)
+        expect(doc.ivar(:person)).to be == person
       end
     end
 

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

@@ -2310,9 +2310,37 @@ describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
         person.addresses.create!(street: "Bond St")
       end
 
+      let(:address) { person.addresses.first }
+
       it "returns true" do
         expect(person.addresses.exists?).to be true
       end
+
+      context 'when given specifying conditions' do
+        context 'when the record exists in the association' do
+          it 'returns true by condition' do
+            expect(person.addresses.exists?(street: 'Bond St')).to be true
+          end
+
+          it 'returns true by id' do
+            expect(person.addresses.exists?(address._id)).to be true
+          end
+
+          it 'returns false when given false' do
+            expect(person.addresses.exists?(false)).to be false
+          end
+
+          it 'returns false when given nil' do
+            expect(person.addresses.exists?(nil)).to be false
+          end
+        end
+
+        context 'when the record does not exist in the association' do
+          it 'returns false' do
+            expect(person.addresses.exists?(street: 'Garfield Ave')).to be false
+          end
+        end
+      end
     end
 
     context "when no documents exist in the database" do
@@ -2324,6 +2352,13 @@ describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
       it "returns false" do
         expect(person.addresses.exists?).to be false
       end
+
+      context 'when given specifying conditions' do
+        it 'returns false' do
+          expect(person.addresses.exists?(street: 'Hyde Park Dr')).to be false
+          expect(person.addresses.exists?(street: 'Garfield Ave')).to be false
+        end
+      end
     end
   end
 

data/spec/mongoid/association/embedded/embeds_many_query_spec.rb

@@ -27,6 +27,10 @@ describe Mongoid::Association::Embedded::EmbedsMany do
       expect(legislator.attributes.keys).to eq(['_id', 'a'])
     end
 
+    it 'allows accessing the parent' do
+      expect { legislator.congress }.not_to raise_error
+    end
+
     context 'when using only with $' do
       before do
         Patient.destroy_all

data/spec/mongoid/association/referenced/belongs_to/proxy_spec.rb

@@ -749,6 +749,10 @@ describe Mongoid::Association::Referenced::BelongsTo::Proxy do
           person.save!
         end
 
+        # NOTE: there as a bad interdependency here, with the auto_save_spec.rb
+        # file. If auto_save_spec.rb runs before this, the following specs fail
+        # with "undefined method `nullify' for an instance of Person".
+
         context "when parent exists" do
 
           context "when child is destroyed" do

data/spec/mongoid/association/referenced/has_and_belongs_to_many/proxy_spec.rb

@@ -1755,43 +1755,6 @@ describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
       end
     end
 
-    describe "#any?" do
-
-      let(:person) do
-        Person.create!
-      end
-
-      context "when nothing exists on the relation" do
-
-        context "when no document is added" do
-
-          let!(:sandwich) do
-            Sandwich.create!
-          end
-
-          it "returns false" do
-            expect(sandwich.meats.any?).to be false
-          end
-        end
-
-        context "when the document is destroyed" do
-
-          before do
-            Meat.create!
-          end
-
-          let!(:sandwich) do
-            Sandwich.create!
-          end
-
-          it "returns false" do
-            sandwich.destroy
-            expect(sandwich.meats.any?).to be false
-          end
-        end
-      end
-    end
-
     context "when documents have been persisted" do
 
       let!(:preference) do
@@ -3041,6 +3004,34 @@ describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
         end
       end
 
+      # MONGOID-5844
+      #
+      # Specifically, this tests the case where the association is
+      # initialized with a single element (so that Proxy#push does not take
+      # the `concat` route), which causes `reset_unloaded` to be called, which
+      # sets the `_unloaded` Criteria object to match only the specific element
+      # that was given.
+      #
+      # The issue now is that when the events list is updated to be both events,
+      # _unloaded matches one of them already, and the other has previously been
+      # persisted so `new_record?` won't match it. We need to make sure the
+      # `#size` logic properly accounts for this case.
+      context 'when documents have been previously persisted' do
+        let(:person1) { Person.create! }
+        let(:person2) { Person.create! }
+        let(:event1) { Event.create!(administrators: [ person1 ]) }
+        let(:event2) { Event.create!(administrators: [ person2 ]) }
+
+        before do
+          person1.administrated_events = [ event1, event2 ]
+        end
+
+        it 'returns the number of associated documents [MONGOID-5844]' do
+          expect(person1.administrated_events.to_a.size).to eq(2)
+          expect(person1.administrated_events.size).to eq(2)
+        end
+      end
+
       context "when documents have not been persisted" do
 
         before do

data/spec/mongoid/association/referenced/has_many/proxy_spec.rb

@@ -2395,6 +2395,42 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           end
         end
       end
+
+      context 'when invoked with specifying conditions' do
+        let(:other_person) { Person.create! }
+        let(:post) { person.posts.first }
+
+        before do
+          person.posts.create title: 'bumfuzzle'
+          other_person.posts.create title: 'bumbershoot'
+        end
+
+        context 'when the conditions match an associated record' do
+          it 'detects its existence by condition' do
+            expect(person.posts.exists?(title: 'bumfuzzle')).to be true
+            expect(other_person.posts.exists?(title: 'bumbershoot')).to be true
+          end
+
+          it 'detects its existence by id' do
+            expect(person.posts.exists?(post._id)).to be true
+          end
+
+          it 'returns false when given false' do
+            expect(person.posts.exists?(false)).to be false
+          end
+
+          it 'returns false when given nil' do
+            expect(person.posts.exists?(nil)).to be false
+          end
+        end
+
+        context 'when the conditions match an unassociated record' do
+          it 'does not detect its existence' do
+            expect(person.posts.exists?(title: 'bumbershoot')).to be false
+            expect(other_person.posts.exists?(title: 'bumfuzzle')).to be false
+          end
+        end
+      end
     end
 
     context "when documents exist in application but not in database" do
@@ -2465,6 +2501,12 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           end
         end
       end
+
+      context 'when invoked with specifying conditions' do
+        it 'returns false' do
+          expect(person.posts.exists?(title: 'hullaballoo')).to be false
+        end
+      end
     end
   end