mongoid 7.4.0 → 8.0.3

data/lib/mongoid/threaded.rb

@@ -45,7 +45,7 @@ module Mongoid
     # @example Get the global database override.
     #   Threaded.database_override
     #
-    # @return [ String, Symbol ] The override.
+    # @return [ String | Symbol ] The override.
     def database_override
       Thread.current[DATABASE_OVERRIDE_KEY]
     end
@@ -55,9 +55,9 @@ module Mongoid
     # @example Set the global database override.
     #   Threaded.database_override = :testing
     #
-    # @param [ String, Symbol ] name The global override name.
+    # @param [ String | Symbol ] name The global override name.
     #
-    # @return [ String, Symbol ] The override.
+    # @return [ String | Symbol ] The override.
     def database_override=(name)
       Thread.current[DATABASE_OVERRIDE_KEY] = name
     end
@@ -167,7 +167,7 @@ module Mongoid
     # @example Get the global client override.
     #   Threaded.client_override
     #
-    # @return [ String, Symbol ] The override.
+    # @return [ String | Symbol ] The override.
     def client_override
       Thread.current[CLIENT_OVERRIDE_KEY]
     end
@@ -177,9 +177,9 @@ module Mongoid
     # @example Set the global client override.
     #   Threaded.client_override = :testing
     #
-    # @param [ String, Symbol ] name The global override name.
+    # @param [ String | Symbol ] name The global override name.
     #
-    # @return [ String, Symbol ] The override.
+    # @return [ String | Symbol ] The override.
     def client_override=(name)
       Thread.current[CLIENT_OVERRIDE_KEY] = name
     end
@@ -255,7 +255,7 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     #
-    # @return [ true, false ] If the document is autosaved.
+    # @return [ true | false ] If the document is autosaved.
     def autosaved?(document)
       autosaves_for(document.class).include?(document._id)
     end
@@ -267,7 +267,7 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     #
-    # @return [ true, false ] If the document is validated.
+    # @return [ true | false ] If the document is validated.
     def validated?(document)
       validations_for(document.class).include?(document._id)
     end
@@ -322,7 +322,7 @@ module Mongoid
     #
     # @param [ Mongo::Session ] session The session to save.
     def set_session(session)
-      Thread.current[:session] = session
+      Thread.current["[mongoid]:session"] = session
     end
 
     # Get the cached session for this thread.
@@ -330,9 +330,9 @@ module Mongoid
     # @example Get the session for this thread.
     #   Threaded.get_session
     #
-    # @return [ Mongo::Session, nil ] The session cached on this thread or nil.
+    # @return [ Mongo::Session | nil ] The session cached on this thread or nil.
     def get_session
-      Thread.current[:session]
+      Thread.current["[mongoid]:session"]
     end
 
     # Clear the cached session for this thread.
@@ -344,7 +344,7 @@ module Mongoid
     def clear_session
       session = get_session
       session.end_session if session
-      Thread.current[:session] = nil
+      Thread.current["[mongoid]:session"] = nil
     end
   end
 end

data/lib/mongoid/timestamps/created.rb

@@ -23,7 +23,7 @@ module Mongoid
       #   person.set_created_at
       def set_created_at
         if !timeless? && !created_at
-          time = Time.now.utc
+          time = Time.configured.now
           self.updated_at = time if is_a?(Updated) && !updated_at_changed?
           self.created_at = time
         end

data/lib/mongoid/timestamps/updated.rb

@@ -24,7 +24,7 @@ module Mongoid
       #   person.set_updated_at
       def set_updated_at
         if able_to_set_updated_at?
-          self.updated_at = Time.now.utc unless updated_at_changed?
+          self.updated_at = Time.configured.now unless updated_at_changed?
         end
 
         clear_timeless_option
@@ -35,7 +35,7 @@ module Mongoid
       # @example Can the timestamp be set?
       #   document.able_to_set_updated_at?
       #
-      # @return [ true, false ] If the timestamp can be set.
+      # @return [ true | false ] If the timestamp can be set.
       def able_to_set_updated_at?
         !frozen? && !timeless? && (new_record? || changed?)
       end

data/lib/mongoid/touchable.rb

@@ -19,10 +19,10 @@ module Mongoid
       #
       # @param [ Symbol ] field The name of an additional field to update.
       #
-      # @return [ true/false ] false if record is new_record otherwise true.
+      # @return [ true/false ] false if document is new_record otherwise true.
       def touch(field = nil)
         return false if _root.new_record?
-        current = Time.now
+        current = Time.configured.now
         field = database_field_name(field)
         write_attribute(:updated_at, current) if respond_to?("updated_at=")
         write_attribute(field, current) if field
@@ -60,7 +60,6 @@ module Mongoid
 
         # Callbacks are invoked on the composition root first and on the
         # leaf-most embedded document last.
-        # TODO add tests, see MONGOID-5015.
         run_callbacks(:touch)
         true
       end

data/lib/mongoid/traversable.rb

@@ -178,7 +178,10 @@ module Mongoid
         to_expand = []
         expanding.each do |child|
           next if expanded[child]
-          expanded[child] = true
+          # Don't mark expanded if _id is nil, since documents are compared by
+          # their _ids, multiple embedded documents with nil ids will compare
+          # equally, and some documents will not be expanded.
+          expanded[child] = true if child._id
           children << child
           to_expand += child._children
         end
@@ -200,7 +203,7 @@ module Mongoid
     # @example Check if the document is a subclass
     #   Square.new.hereditary?
     #
-    # @return [ true, false ] True if hereditary, false if not.
+    # @return [ true | false ] True if hereditary, false if not.
     def hereditary?
       self.class.hereditary?
     end
@@ -230,6 +233,7 @@ module Mongoid
     def remove_child(child)
       name = child.association_name
       if child.embedded_one?
+        self.attributes.delete(child._association.store_as)
         remove_ivar(name)
       else
         relation = send(name)
@@ -279,7 +283,7 @@ module Mongoid
     # @example Is the document the root?
     #   document._root?
     #
-    # @return [ true, false ] If the document is the root.
+    # @return [ true | false ] If the document is the root.
     def _root?
       _parent ? false : true
     end
@@ -291,7 +295,7 @@ module Mongoid
       # @example Check if the document is a subclass.
       #   Square.hereditary?
       #
-      # @return [ true, false ] True if hereditary, false if not.
+      # @return [ true | false ] True if hereditary, false if not.
       def hereditary?
         !!(Mongoid::Document > superclass)
       end

data/lib/mongoid/validatable/localizable.rb

@@ -12,7 +12,7 @@ module Mongoid
       #   validator.validate_each(model, :name, "value")
       #
       # @param [ Document ] document The document.
-      # @param [ Symbol, String ] attribute The attribute to validate.
+      # @param [ Symbol | String ] attribute The attribute to validate.
       # @param [ Object ] value The attribute value.
       def validate_each(document, attribute, value)
         field = document.fields[document.database_field_name(attribute)]

data/lib/mongoid/validatable/macros.rb

@@ -19,7 +19,6 @@ module Mongoid
       #   end
       #
       # @param [ Array ] args The arguments to pass to the validator.
-      #
       def validates_associated(*args)
         validates_with(AssociatedValidator, _merge_attributes(args))
       end
@@ -37,7 +36,6 @@ module Mongoid
       #   end
       #
       # @param [ Array ] args The arguments to pass to the validator.
-      #
       def validates_uniqueness_of(*args)
         validates_with(UniquenessValidator, _merge_attributes(args))
       end

data/lib/mongoid/validatable/presence.rb

@@ -56,7 +56,7 @@ module Mongoid
       # @param [ Symbol ] attr The attribute.
       # @param [ Object ] value The value.
       #
-      # @return [ true, false ] If the doc is missing.
+      # @return [ true | false ] If the doc is missing.
       def relation_or_fk_missing?(doc, attr, value)
         return true if value.blank? && doc.send(attr).blank?
         association = doc.relations[attr.to_s]
@@ -72,7 +72,7 @@ module Mongoid
       #
       # @param [ Object ] value The value.
       #
-      # @return [ true, false ] If the value is not present.
+      # @return [ true | false ] If the value is not present.
       def not_present?(value)
         value.blank? && value != false
       end

data/lib/mongoid/validatable/uniqueness.rb

@@ -16,7 +16,7 @@ module Mongoid
     #   end
     #
     # It is also possible to limit the uniqueness constraint to a set of
-    # records matching certain conditions:
+    # documents matching certain conditions:
     #   class Person
     #     include Mongoid::Document
     #     field :title
@@ -74,7 +74,7 @@ module Mongoid
       # @example Is the validation case sensitive?
       #   validator.case_sensitive?
       #
-      # @return [ true, false ] If the validation is case sensitive.
+      # @return [ true | false ] If the validation is case sensitive.
       def case_sensitive?
         !(options[:case_sensitive] == false)
       end
@@ -86,7 +86,7 @@ module Mongoid
       # @example Create the criteria.
       #   validator.create_criteria(User, user, :name, "syd")
       #
-      # @param [ Class, Proxy ] base The base to execute the criteria from.
+      # @param [ Class | Proxy ] base The base to execute the criteria from.
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The name of the attribute.
       # @param [ Object ] value The value of the object.
@@ -149,7 +149,7 @@ module Mongoid
       #
       # @param [ Object ] value The value to filter.
       #
-      # @return [ Object, Regexp ] The value, filtered or not.
+      # @return [ Object | Regexp ] The value, filtered or not.
       def filter(value)
         !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
@@ -182,7 +182,7 @@ module Mongoid
       #
       # @param [ Document ] document The embedded document.
       #
-      # @return [ true, false ] If the validation should be skipped.
+      # @return [ true | false ] If the validation should be skipped.
       def skip_validation?(document)
         !document._parent || document.embedded_one?
       end
@@ -196,7 +196,7 @@ module Mongoid
       #
       # @param [ Document ] document The embedded document.
       #
-      # @return [ true, false ] If the scope reference has changed.
+      # @return [ true | false ] If the scope reference has changed.
       def scope_value_changed?(document)
         Array.wrap(options[:scope]).any? do |item|
           document.send("attribute_changed?", item.to_s)
@@ -242,6 +242,7 @@ module Mongoid
         relation = document._parent.send(document.association_name)
         criteria = create_criteria(relation, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
+        criteria = criteria.limit(2)
         add_error(document, attribute, value) if criteria.count > 1
       end
 
@@ -277,7 +278,7 @@ module Mongoid
       # @param [ Document ] document The document getting validated.
       # @param [ Symbol ] attribute The attribute to validate.
       #
-      # @return [ true, false ] If we need to validate.
+      # @return [ true | false ] If we need to validate.
       def validation_required?(document, attribute)
         document.new_record? ||
           document.send("attribute_changed?", attribute.to_s) ||
@@ -294,7 +295,7 @@ module Mongoid
       # @param [ Document ] document The document getting validated.
       # @param [ Symbol ] attribute The attribute to validate.
       #
-      # @return [ true, false ] If the attribute is localized.
+      # @return [ true | false ] If the attribute is localized.
       def localized?(document, attribute)
         document.fields[document.database_field_name(attribute)].try(:localized?)
       end

data/lib/mongoid/validatable.rb

@@ -44,7 +44,7 @@ module Mongoid
     #
     # @param [ Hash ] options The options to check.
     #
-    # @return [ true, false ] If we are validating.
+    # @return [ true | false ] If we are validating.
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
     end
@@ -83,7 +83,7 @@ module Mongoid
     #
     # @param [ Symbol ] context The optional validation context.
     #
-    # @return [ true, false ] True if valid, false if not.
+    # @return [ true | false ] True if valid, false if not.
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -93,7 +93,7 @@ module Mongoid
     # @example Is the document validated?
     #   document.validated?
     #
-    # @return [ true, false ] Has the document already been validated?
+    # @return [ true | false ] Has the document already been validated?
     def validated?
       Threaded.validated?(self)
     end
@@ -103,7 +103,7 @@ module Mongoid
     # @example Are we validating with a query?
     #   document.validating_with_query?
     #
-    # @return [ true, false ] If we are validating with a query.
+    # @return [ true | false ] If we are validating with a query.
     def validating_with_query?
       self.class.validating_with_query?
     end
@@ -129,7 +129,7 @@ module Mongoid
       # @example Validate with a specific validator.
       #   validates_with MyValidator, on: :create
       #
-      # @param [ Class<Array>, Hash ] args The validator classes and options.
+      # @param [ Class<Array> | Hash ] args The validator classes and options.
       #
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is
@@ -151,7 +151,7 @@ module Mongoid
       # @example Are we validating with a query?
       #   Model.validating_with_query?
       #
-      # @return [ true, false ] If we are validating with a query.
+      # @return [ true | false ] If we are validating with a query.
       def validating_with_query?
         Threaded.executing?("#{name}-validate-with-query")
       end

data/lib/mongoid/version.rb

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

data/lib/mongoid/warnings.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # Encapsulates behavior around logging and caching warnings so they are only
+  # logged once.
+  #
+  # @api private
+  module Warnings
+
+    class << self
+      def warning(id, message)
+        singleton_class.class_eval do
+          define_method("warn_#{id}") do
+            unless instance_variable_get("@#{id}")
+              Mongoid.logger.warn(message)
+              instance_variable_set("@#{id}", true)
+            end
+          end
+        end
+      end
+    end
+
+    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'
+  end
+end

data/lib/mongoid.rb

@@ -16,6 +16,7 @@ require "mongo"
 require 'mongo/active_support'
 
 require "mongoid/version"
+require "mongoid/deprecable"
 require "mongoid/config"
 require "mongoid/persistence_context"
 require "mongoid/loggable"
@@ -23,6 +24,7 @@ require "mongoid/clients"
 require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
+require "mongoid/warnings"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.

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
@@ -120,9 +125,6 @@ development:
     # database name is not explicitly defined. (default: nil)
     # app_name: MyApplicationName
     
-    # Create indexes in background by default. (default: false)
-    # background_indexing: false
-    
     # Mark belongs_to associations as required by default, so that saving a
     # model with a missing belongs_to association will trigger a validation
     # error. (default: true)
@@ -167,6 +169,10 @@ development:
     # (default: false)
     # use_utc: false
 
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    # background_indexing: false
+
 test:
   clients:
     default:

data/spec/config/mongoid.yml

@@ -40,6 +40,22 @@ test:
     app_name: 'testing'
     background_indexing: false
     join_contexts: false
+  driver_options:
+    broken_view_options: false
+    # Don't set validate_update_replace here, as it is used to check if the
+    # default driver options are kept in Mongoid.
+test_nil:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+  driver_options:
+    broken_view_options:
+    validate_update_replace: false
+
 test_with_max_staleness:
   clients:
     default:

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

@@ -5,6 +5,11 @@ 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?
@@ -87,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')
@@ -109,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)
@@ -130,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
 
@@ -157,7 +163,15 @@ describe 'Mongoid application tests' do
               before do
                 Dir.chdir(APP_PATH) do
                   remove_bundler_req
-                  Mrss::ChildProcessHelper.check_call(%w(bundle install), env: env)
+
+                  if BSON::Environment.jruby?
+                    # Remove existing Gemfile.lock - see
+                    # https://github.com/rubygems/rubygems/issues/3231
+                    require 'fileutils'
+                    FileUtils.rm_f('Gemfile.lock')
+                  end
+
+                  check_call(%w(bundle install), env: env)
                   write_mongoid_yml
                 end
 
@@ -171,7 +185,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|
@@ -189,11 +203,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
@@ -281,18 +295,6 @@ describe 'Mongoid application tests' do
         f << lines.join
       end
     end
-
-    if rails_version == '5.1'
-      secrets = {
-        'development' => {
-          'secret_key_base' => 'abracadabra',
-          'my_secret_token' => 'very_secret',
-        },
-      }
-      File.open('config/secrets.yml', 'w') do |f|
-        f << YAML.dump(secrets)
-      end
-    end
   end
 
   def remove_bundler_req
@@ -316,7 +318,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

@@ -12,4 +12,22 @@ describe 'belongs_to associations' do
       expect(child).to be_valid
     end
   end
+
+  context 'when an anonymous class defines a belongs_to association' do
+    let(:klass) do
+      Class.new do
+        include Mongoid::Document
+        belongs_to :movie
+      end
+    end
+
+    it 'loads the association correctly' do
+      expect { klass }.to_not raise_error
+      expect { klass.new.movie }.to_not raise_error
+      instance = klass.new
+      movie = Movie.new
+      instance.movie = movie
+      expect(instance.movie).to eq movie
+    end
+  end
 end