mongoid 7.3.4 → 7.4.1

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -38,8 +37,6 @@ module Mongoid
       # @param [ Object ] value The value of the field.
       #
       # @return [ Errors ] The errors.
-      #
-      # @since 1.0.0
       def validate_each(document, attribute, value)
         with_query(document) do
           attrib, val = to_validate(document, attribute, value)
@@ -64,8 +61,6 @@ module Mongoid
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The name of the attribute.
       # @param [ Object ] value The value of the object.
-      #
-      # @since 2.4.10
       def add_error(document, attribute, value)
         document.errors.add(
           attribute, :taken, **options.except(:case_sensitive, :scope).merge(value: value)
@@ -80,8 +75,6 @@ module Mongoid
       #   validator.case_sensitive?
       #
       # @return [ true, false ] If the validation is case sensitive.
-      #
-      # @since 2.3.0
       def case_sensitive?
         !(options[:case_sensitive] == false)
       end
@@ -99,11 +92,23 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 2.4.10
       def create_criteria(base, document, attribute, value)
         criteria = scope(base.unscoped, document, attribute)
-        criteria.selector.update(criterion(document, attribute, value.mongoize))
+        field = document.fields[document.database_field_name(attribute)]
+
+        # In the past, we were calling value.mongoize in all cases, which
+        # would call Object's mongoize method. This is a problem for StringifiedSymbol,
+        # because a Symbol should mongoize to a String, but calling .mongoize
+        # on a Symbol mongoizes it to a Symbol.
+        # Therefore, we call the field's mongoize in all cases except when the
+        # field is localized, because by the time we arrive at this code, the
+        # value is already in the form of { lang => translation } and calling
+        # the field's mongoize will nest that further into { lang =>
+        # "\{ lang => translation \}"} (assuming the field type is a string).
+        # Therefore, we call Object's mongoize method so it returns the hash as
+        # it is.
+        mongoized = field.try(:localized?) ? value.mongoize : field.mongoize(value)
+        criteria.selector.update(criterion(document, attribute, mongoized))
         criteria
       end
 
@@ -119,8 +124,6 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The uniqueness criteria.
-      #
-      # @since 2.3.0
       def criterion(document, attribute, value)
         field = document.database_field_name(attribute)
 
@@ -147,8 +150,6 @@ module Mongoid
       # @param [ Object ] value The value to filter.
       #
       # @return [ Object, Regexp ] The value, filtered or not.
-      #
-      # @since 2.3.0
       def filter(value)
         !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
@@ -164,8 +165,6 @@ module Mongoid
       # @param [ Document ] document The document being validated.
       #
       # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 2.3.0
       def scope(criteria, document, _attribute)
         Array.wrap(options[:scope]).each do |item|
           name = document.database_field_name(item)
@@ -184,8 +183,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the validation should be skipped.
-      #
-      # @since 2.3.0
       def skip_validation?(document)
         !document._parent || document.embedded_one?
       end
@@ -200,8 +197,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the scope reference has changed.
-      #
-      # @since
       def scope_value_changed?(document)
         Array.wrap(options[:scope]).any? do |item|
           document.send("attribute_changed?", item.to_s)
@@ -223,8 +218,6 @@ module Mongoid
       # @param [ Object ] value The value of the attribute.
       #
       # @return [ Array<Object, Object> ] The field and value.
-      #
-      # @since 2.4.4
       def to_validate(document, attribute, value)
         association = document.relations[attribute.to_s]
         if association && association.stores_foreign_key?
@@ -244,8 +237,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_embedded(document, attribute, value)
         return if skip_validation?(document)
         relation = document._parent.send(document.association_name)
@@ -264,8 +255,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_root(document, attribute, value)
         klass = document.class
 
@@ -289,8 +278,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If we need to validate.
-      #
-      # @since 2.4.4
       def validation_required?(document, attribute)
         document.new_record? ||
           document.send("attribute_changed?", attribute.to_s) ||
@@ -308,8 +295,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If the attribute is localized.
-      #
-      # @since 4.0.0
       def localized?(document, attribute)
         document.fields[document.database_field_name(attribute)].try(:localized?)
       end

data/lib/mongoid/validatable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/validatable/macros"
 require "mongoid/validatable/localizable"
@@ -26,8 +25,6 @@ module Mongoid
     #
     # @example Begin validation.
     #   document.begin_validate
-    #
-    # @since 2.1.9
     def begin_validate
       Threaded.begin_validate(self)
     end
@@ -36,8 +33,6 @@ module Mongoid
     #
     # @example Exit validation.
     #   document.exit_validate
-    #
-    # @since 2.1.9
     def exit_validate
       Threaded.exit_validate(self)
     end
@@ -50,8 +45,6 @@ module Mongoid
     # @param [ Hash ] options The options to check.
     #
     # @return [ true, false ] If we are validating.
-    #
-    # @since 4.0.0
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
     end
@@ -66,8 +59,6 @@ module Mongoid
     # @param [ Symbol ] attr The name of the field or association.
     #
     # @return [ Object ] The value of the field or the association.
-    #
-    # @since 2.0.0.rc.1
     def read_attribute_for_validation(attr)
       attribute = database_field_name(attr)
       if relations.key?(attribute)
@@ -93,8 +84,6 @@ module Mongoid
     # @param [ Symbol ] context The optional validation context.
     #
     # @return [ true, false ] True if valid, false if not.
-    #
-    # @since 2.0.0.rc.6
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -105,8 +94,6 @@ module Mongoid
     #   document.validated?
     #
     # @return [ true, false ] Has the document already been validated?
-    #
-    # @since 2.0.0.rc.2
     def validated?
       Threaded.validated?(self)
     end
@@ -117,8 +104,6 @@ module Mongoid
     #   document.validating_with_query?
     #
     # @return [ true, false ] If we are validating with a query.
-    #
-    # @since 3.0.2
     def validating_with_query?
       self.class.validating_with_query?
     end
@@ -132,15 +117,13 @@ module Mongoid
       #   Person.validates_relation(association)
       #
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def validates_relation(association)
         if association.validate?
           validates_associated(association.name)
         end
       end
 
-      # Add validation with the supplied validators forthe provided fields
+      # Add validation with the supplied validators for the provided fields
       # with options.
       #
       # @example Validate with a specific validator.
@@ -151,8 +134,6 @@ module Mongoid
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is
       #   added.
-      #
-      # @since 3.0.0
       def validates_with(*args, &block)
         if args.first == PresenceValidator
           args.last[:attributes].each do |name|
@@ -171,8 +152,6 @@ module Mongoid
       #   Model.validating_with_query?
       #
       # @return [ true, false ] If we are validating with a query.
-      #
-      # @since 3.0.2
       def validating_with_query?
         Threaded.executing?("#{name}-validate-with-query")
       end

data/lib/mongoid/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
-  VERSION = "7.3.4"
+  VERSION = "7.4.1"
 end

data/lib/mongoid.rb

@@ -1,7 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
-
-require "support/ruby_version"
 
 require "forwardable"
 require "time"
@@ -42,8 +39,6 @@ module Mongoid
   extend self
 
   # A string added to the platform details of Ruby driver client handshake documents.
-  #
-  # @since 6.1.0
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
@@ -62,8 +57,6 @@ module Mongoid
   #   end
   #
   # @return [ Config ] The configuration object.
-  #
-  # @since 1.0.0
   def configure
     block_given? ? yield(Config) : Config
   end
@@ -74,8 +67,6 @@ module Mongoid
   #   Mongoid.default_client
   #
   # @return [ Mongo::Client ] The default client.
-  #
-  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -86,8 +77,6 @@ module Mongoid
   #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -98,8 +87,6 @@ module Mongoid
   #   Mongoid.client(:default)
   #
   # @return [ Mongo::Client ] The named client.
-  #
-  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end
@@ -109,8 +96,6 @@ module Mongoid
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
-  #
-  # @since 1.0.0
   def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
 
 

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'rails/generators/mongoid_generator'
 

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -80,8 +80,13 @@ development:
         # (default: 10)
         # connect_timeout: 10
 
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
+        # How long to wait for a response for each operation sent to the
+        # server. This timeout should be set to a value larger than the
+        # processing time for the longest operation that will be executed
+        # by the application. Note that this is a client-side timeout;
+        # the server may continue executing an operation after the client
+        # aborts it with the SocketTimeout exception.
+        # (default: nil, meaning no timeout)
         # socket_timeout: 5
 
         # The name of the replica set to connect to. Servers provided as seeds that do

data/lib/rails/generators/mongoid/model/model_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "rails/generators/mongoid_generator"
 

data/lib/rails/generators/mongoid_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "rails/generators/named_base"
 require "rails/generators/active_model"

data/lib/rails/mongoid.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Rails
   module Mongoid
@@ -45,8 +44,6 @@ module Rails
     #   Mongoid.load_model("/mongoid/behavior")
     #
     # @param [ String ] file The base filename.
-    #
-    # @since 2.0.0.rc.3
     def load_model(file)
       begin
         require_dependency(file)

data/spec/config/mongoid_with_schema_map_uuid.yml

@@ -0,0 +1,27 @@
+test:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        auto_encryption_options:
+          key_vault_namespace: 'admin.datakeys'
+          kms_providers:
+            local:
+              key: "z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U"
+          schema_map:
+            blog_development.comments:
+              properties:
+                message:
+                  encrypt:
+                    keyId:
+                      - !ruby/object:BSON::Binary
+                        data: !binary |-
+                          R/AgNcxASFiiJWKXqWGo5w==
+                        type: :uuid
+                    bsonType: "string"
+                    algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+              bsonType: "object"

data/spec/integration/app_spec.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 
 BASE = File.join(File.dirname(__FILE__), '../..')
 TMP_BASE = File.join(BASE, 'tmp')
 
+def check_call(cmd, **opts)
+  puts "Executing #{cmd.join(' ')}"
+  Mrss::ChildProcessHelper.check_call(cmd, **opts)
+end
+
 describe 'Mongoid application tests' do
   before(:all) do
     unless SpecConfig.instance.app_tests?
@@ -88,14 +92,14 @@ describe 'Mongoid application tests' do
 
       Dir.chdir(TMP_BASE) do
         FileUtils.rm_rf('mongoid-test')
-        Mrss::ChildProcessHelper.check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
+        check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
 
         Dir.chdir('mongoid-test') do
           adjust_app_gemfile
-          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+          check_call(%w(bundle install), env: clean_env)
 
-          Mrss::ChildProcessHelper.check_call(%w(rails g model post), env: clean_env)
-          Mrss::ChildProcessHelper.check_call(%w(rails g model comment post:belongs_to), env: clean_env)
+          check_call(%w(rails g model post), env: clean_env)
+          check_call(%w(rails g model comment post:belongs_to), env: clean_env)
 
           # https://jira.mongodb.org/browse/MONGOID-4885
           comment_text = File.read('app/models/comment.rb')
@@ -110,16 +114,16 @@ describe 'Mongoid application tests' do
 
       Dir.chdir(TMP_BASE) do
         FileUtils.rm_rf('mongoid-test-config')
-        Mrss::ChildProcessHelper.check_call(%w(rails new mongoid-test-config --skip-spring --skip-active-record), env: clean_env)
+        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
-          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+          check_call(%w(bundle install), env: clean_env)
 
           mongoid_config_file = File.join(TMP_BASE,'mongoid-test-config/config/mongoid.yml')
 
           File.exist?(mongoid_config_file).should be false
-          Mrss::ChildProcessHelper.check_call(%w(rails g mongoid:config), env: clean_env)
+          check_call(%w(rails g mongoid:config), env: clean_env)
           File.exist?(mongoid_config_file).should be true
 
           config_text = File.read(mongoid_config_file)
@@ -131,10 +135,11 @@ describe 'Mongoid application tests' do
   end
 
   def install_rails
-    Mrss::ChildProcessHelper.check_call(%w(gem uni rails -a))
+    check_call(%w(gem uni rails -a))
     if (rails_version = SpecConfig.instance.rails_version) == 'master'
     else
-      Mrss::ChildProcessHelper.check_call(%w(gem install rails --no-document -v) + [rails_version])
+      check_call(%w(gem list))
+      check_call(%w(gem install rails --no-document -v) + ["~> #{rails_version}.0"])
     end
   end
 
@@ -158,7 +163,7 @@ describe 'Mongoid application tests' do
               before do
                 Dir.chdir(APP_PATH) do
                   remove_bundler_req
-                  Mrss::ChildProcessHelper.check_call(%w(bundle install), env: env)
+                  check_call(%w(bundle install), env: env)
                   write_mongoid_yml
                 end
 
@@ -172,7 +177,7 @@ describe 'Mongoid application tests' do
                 end
                 index.should be nil
 
-                Mrss::ChildProcessHelper.check_call(%w(bundle exec rake db:mongoid:create_indexes),
+                check_call(%w(bundle exec rake db:mongoid:create_indexes -t),
                   cwd: APP_PATH, env: env)
 
                 index = client['posts'].indexes.detect do |index|
@@ -190,11 +195,11 @@ describe 'Mongoid application tests' do
   def clone_application(repo_url, subdir: nil)
     Dir.chdir(TMP_BASE) do
       FileUtils.rm_rf(File.basename(repo_url))
-      Mrss::ChildProcessHelper.check_call(%w(git clone) + [repo_url])
+      check_call(%w(git clone) + [repo_url])
       Dir.chdir(File.join(*[File.basename(repo_url), subdir].compact)) do
         adjust_app_gemfile
         adjust_rails_defaults
-        Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+        check_call(%w(bundle install), env: clean_env)
         puts `git diff`
 
         write_mongoid_yml
@@ -317,7 +322,7 @@ describe 'Mongoid application tests' do
     # in `initialize': too long unix socket path (126bytes given but 108bytes max) (ArgumentError)
     # Is it trying to create unix sockets in current directory?
     # https://stackoverflow.com/questions/30302021/rails-runner-without-spring
-    Mrss::ChildProcessHelper.check_call(%w(bin/spring binstub --remove --all), env: clean_env)
+    check_call(%w(bin/spring binstub --remove --all), env: clean_env)
   end
 
   def clean_env

data/spec/integration/associations/belongs_to_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative '../../mongoid/association/referenced/has_one_models'

data/spec/integration/associations/embedded_dirty_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../mongoid/association/embedded/embeds_many_models'
+require_relative '../../mongoid/association/embedded/embeds_one_models'
+
+describe 'embedded associations' do
+  describe 'dirty tracking' do
+    context 'when association is cyclic' do
+      before do
+        # create deeply nested record
+        a = EmmOuter.create(level: 0)
+        level = 1
+        iter = a.inners.create(level: level)
+        loop do
+          iter.friends.create(level: (level += 1))
+          iter = iter.friends[0]
+          break if level == 40
+        end
+      end
+
+      let(:subject) { EmmOuter.first }
+
+      it 'performs dirty tracking efficiently' do
+        subject.changed?.should be false
+      end
+
+      it 'calculates the descendants properly' do
+        expect(subject._descendants.length).to eq(40)
+      end
+    end
+
+    context 'when association is cyclic and the _id is nil' do
+      before do
+        # create deeply nested record
+        a = EmmOuter.create(level: 0)
+        level = 1
+        iter = a.inners.create(id: nil, level: level)
+        loop do
+          iter.friends.create(id: nil, level: (level += 1))
+          iter = iter.friends[0]
+          break if level == 40
+        end
+      end
+
+      let(:subject) { EmmOuter.first }
+
+      it 'performs dirty tracking efficiently' do
+        subject.changed?.should be false
+      end
+
+      it 'calculates the descendants properly' do
+        expect(subject._descendants.length).to eq(40)
+      end
+    end
+  end
+end

data/spec/integration/associations/embedded_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative '../../mongoid/association/embedded/embeds_many_models'

data/spec/integration/associations/embeds_many_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/embeds_one_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/foreign_key_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative './foreign_key_spec_models'

data/spec/integration/associations/foreign_key_spec_models.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module ForeignKeySpec
   class Company

data/spec/integration/associations/has_many_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_many_models'

data/spec/integration/associations/has_one_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_one_models'

data/spec/integration/associations/nested_attributes_assignment_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/reverse_population_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative './reverse_population_spec_models'

data/spec/integration/associations/reverse_population_spec_models.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module ReversePopulationSpec
   class Company