mongoid 8.1.5 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe9ca12b60eeee360717af6f05117691a514c4b37f645c456b7c2675ab60606
-  data.tar.gz: 145e999e0a17a6eff2d19c7188a2aee7f27785308f507cd57df1d8ac74ebe93d
+  metadata.gz: 38b7f297f31cb9dbf9e703769a789969ef5de77ba9f7b0ebf998c0aec1c76524
+  data.tar.gz: 0aeb2382db008ef20fe7635546da3c13df040933b31005c859747d8cd16247f9
 SHA512:
-  metadata.gz: bb5249dd2e2eea2d2ba3fdfa2c84c3dbaa71b181e22ff2a181854ce029499cf723487b00ec4ad4eef0619fda4bfcf3b071f36dc436ef46321fcf7c99319124d4
-  data.tar.gz: 1ff5ba0852368f7f032c80e18bcfd27934ee35a3e91e84197e6641f0d966b914c29c5aac8cd4e81df720db2b8b8bd54c42fc25e9b2c8a9e8cf1fb33f9da8cc89
+  metadata.gz: de6b4d0dbf469baaa5900cbd968a82d74d3eaf1f2b52cc002ddbb37f1531a343c0b5e48a54b47e554a81a1389c7daf43653aa9338653fa7eb7c171d309dd2990
+  data.tar.gz: 1202e0a37c944780c9b9b7ffca7a89736df81d7dd8757bfd0c2c2ec6723e7ee1ebc088feeca7479a1103fc3290ff679282bc5241cf67335505e56e08a0fee1d6

data/LICENSE

@@ -1,5 +1,5 @@
+Copyright (c) 2015-Present MongoDB Inc.  
 Copyright (c) 2009-2016 Durran Jordan
-Copyright (c) 2015-2020 MongoDB, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -19,9 +19,9 @@ Compatibility
 
 Mongoid supports and is tested against:
 
-- MRI 2.6 - 3.1
-- JRuby 9.3
-- MongoDB server 3.6 - 6.0
+- MRI 2.7 - 3.2
+- JRuby 9.4
+- MongoDB server 3.6 - 7.0
 
 Issues
 ------
@@ -39,8 +39,8 @@ Support
 License
 -------
 
+Copyright (c) 2015-Present MongoDB Inc.
 Copyright (c) 2009-2016 Durran Jordan
-Copyright (c) 2015-2020 MongoDB, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -61,11 +61,6 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Credits
--------
-
-Durran Jordan: durran at gmail dot com
-
 [rubygems-img]: https://badge.fury.io/rb/mongoid.svg
 [rubygems-url]: http://badge.fury.io/rb/mongoid
 [inch-img]: http://inch-ci.org/github/mongodb/mongoid.svg?branch=master

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "bundler"
 require "bundler/gem_tasks"
@@ -11,15 +12,6 @@ $: << File.join(ROOT, 'spec/shared/lib')
 require "rake"
 require "rspec/core/rake_task"
 require 'mrss/spec_organizer'
-require 'rubygems/package'
-require 'rubygems/security/policies'
-
-def signed_gem?(path_to_gem)
-  Gem::Package.new(path_to_gem, Gem::Security::HighSecurity).verify
-  true
-rescue Gem::Security::Exception => e
-  false
-end
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "mongoid/version"
@@ -49,6 +41,46 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+desc 'Build and validate the evergreen config'
+task eg: %w[ eg:build eg:validate ]
+
+# 'eg' == 'evergreen', but evergreen is too many letters for convenience
+namespace :eg do
+  desc 'Builds the .evergreen/config.yml file from the templates'
+  task :build do
+    ruby '.evergreen/update-evergreen-configs'
+  end
+
+  desc 'Validates the .evergreen/config.yml file'
+  task :validate do
+    system 'evergreen validate --project mongoid .evergreen/config.yml'
+  end
+
+  desc 'Updates the evergreen executable to the latest available version'
+  task :update do
+    system 'evergreen get-update --install'
+  end
+
+  desc 'Runs the current branch as an evergreen patch'
+  task :patch do
+    system 'evergreen patch --uncommitted --project mongoid --browse --auto-description --yes'
+  end
+end
+
+namespace :generate do
+  desc 'Generates a mongoid.yml from the template'
+  task :config do
+    require 'mongoid'
+    require 'erb'
+
+    template_path = 'lib/rails/generators/mongoid/config/templates/mongoid.yml'
+    database_name = ENV['DATABASE_NAME'] || 'my_db'
+
+    config = ERB.new(File.read(template_path), trim_mode: '-').result(binding)
+    File.write('mongoid.yml', config)
+  end
+end
+
 CLASSIFIERS = [
   [%r,^mongoid/attribute,, :attributes],
   [%r,^mongoid/association/[or],, :associations_referenced],
@@ -97,7 +129,7 @@ desc "Generate all documentation"
 task :docs => 'docs:yard'
 
 namespace :docs do
-  desc "Generate yard documention"
+  desc "Generate yard documentation"
   task :yard do
     out = File.join('yard-docs', Mongoid::VERSION)
     FileUtils.rm_rf(out)
@@ -112,19 +144,3 @@ namespace :release do
     end
   end
 end
-
-desc 'Verifies that all built gems in pkg/ are valid'
-task :verify do
-  gems = Dir['pkg/*.gem']
-  if gems.empty?
-    puts 'There are no gems in pkg/ to verify'
-  else
-    gems.each do |gem|
-      if signed_gem?(gem)
-        puts "#{gem} is signed"
-      else
-        abort "#{gem} is not signed"
-      end
-    end
-  end
-end

data/lib/config/locales/en.yml

@@ -23,6 +23,17 @@ en:
           resolution: "On the %{name} association on %{inverse} you must add an
             :inverse_of option to specify the exact association on %{klass}
             that is the opposite of %{name}."
+        attribute_not_loaded:
+          message: "Attempted to access attribute '%{name}' on %{klass} which
+            was not loaded."
+          summary:
+            "You loaded an instance of %{klass} using a query projection method
+            such as `.only` or `.without`, then attempted to read or write an
+            attribute '%{name}' which was not included in the projection.
+            Mongoid intentionally prevents this to avoid overwriting data."
+          resolution: "Ensure your query projection methods such as `.only` and
+            `.without` include field '%{name}' when loading instances of %{klass},
+            or remove such projections methods entirely."
         callbacks:
           message: "Calling %{method} on %{klass} resulted in a false return
             from a callback."
@@ -137,6 +148,23 @@ en:
             expecting the option to be there, please consult the following page
             with respect to Mongoid's configuration:\n\n
             \_\_https://www.mongodb.com/docs/mongoid/current/reference/configuration/#mongoid-configuration-options"
+        invalid_auto_encryption_configuration:
+          message: "Invalid automatic encryption configuration for client %{client}."
+          summary: "Automatic encryption options for client %{client} are
+            incomplete or invalid."
+          resolution: "Please consult the following page with respect to
+            automatic encryption configuration:\n\n
+            \_\_https://www.mongodb.com/docs/ruby-driver/current/reference/client-side-encryption/#auto-encryption-options"
+        invalid_auto_encryption_configuration_for_kms_provider:
+          message: "Automatic encryption configuration for client %{client} does
+            not include options for kms_provider %{kms_provider}"
+          summary: "Automatic encryption configuration for client %{client} does
+            not include options for kms_provider %{kms_provider} in :kms_providers
+            hash."
+          resolution: "Check kms_provider name and :kms_providers options.
+            Please consult the following page with respect to
+            automatic encryption configuration:\n\n
+            \_\_https://www.mongodb.com/docs/ruby-driver/current/reference/client-side-encryption/#auto-encryption-options"
         invalid_config_file:
           message: "Invalid configuration file: %{path}."
           summary: "Your mongoid.yml configuration file does not contain the
@@ -185,8 +213,13 @@ en:
           message: "Invalid criteria for estimated_count."
           summary: "Estimated count is strictly a collection-level operation and cannot be called
             on a filtered criteria."
-          resolution: "Try calling estimated_count directly on the class: %{class_name}.estimated_count.\n\n
-            \_If the class defines a default scope, use unscoped: %{class_name}.unscoped.estimated_count."
+          resolution: "Try calling estimated_count directly on the class: %{class_name}.estimated_count."
+        invalid_estimated_count_scoping:
+          message: "Invalid criteria for estimated_count."
+          summary: "Estimated count is strictly a collection-level operation and cannot be called
+            on a model that uses a default scope."
+          resolution: "Try calling estimated_count using unscoped: %{class_name}.unscoped.estimated_count.
+            Alternatively, the #count method can be used, which is usable with scoping."
         invalid_expression_operator:
           message: "Invalid expression operator '%{operator}'."
           summary: "You misspelled an operator, are using an operator that
@@ -348,9 +381,9 @@ en:
             in the session block share the same driver client. For example, a model may have a different
             client specified in its 'store_in' options.\n\n"
         invalid_session_nesting:
-          message: "A session was started while another session was being used."
-          summary: "Sessions cannot be nested. Only one session can be used in a thread at once."
-          resolution: "Only use one session at a time; sessions cannot be nested."
+          message: "A session was started while another session was being used on this client."
+          summary: "Sessions cannot be nested. Only one session can be used in a thread per client."
+          resolution: "Only use one session per client at a time; sessions cannot be nested."
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
@@ -372,6 +405,10 @@ en:
             for Date, DateTime, and Time objects. When this is a String it needs
             to be valid for Time.parse. Other objects must be valid to pass to
             Time.local."
+        invalid_transaction_nesting:
+          message: "A transaction was started while another transaction was being used on this client."
+          summary: "Transactions cannot be nested. Only one transaction can be used in a thread per client."
+          resolution: "Only use one transaction per client at a time; transactions cannot be nested."
         inverse_not_found:
           message: "When adding a(n) %{klass} to %{base}#%{name}, Mongoid could
             not determine the inverse foreign key to set. The attempted key was
@@ -608,6 +645,19 @@ en:
             accepts_nested_attributes_for :%{association}, limit: %{limit}.
             Consider raising this limit or making sure no more are sent than
             the set value."
+        transactions_not_supported:
+          message: "Transactions are not supported by the connected server(s)."
+          summary: "A session was attempted to be used with a MongoDB server version
+            that doesn't support transactions. Transactions are supported in MongoDB
+            server versions 3.6 and higher."
+          resolution: "Verify that all servers in your deployment are at least
+            version 3.6 or don't attempt to use transactions with older server versions."
+        transaction_error:
+          message: "Transaction failed with the following error: %{error}."
+          summary: "The transaction failed because MongoDB server or MongoDB driver
+            raised an unexpected error."
+          resolution: "Consult with Ruby driver documentation
+            and MongoDB documentation."
         unknown_attribute:
           message: "Attempted to set a value for '%{name}' which is not
             allowed on the model %{klass}."
@@ -654,3 +704,14 @@ en:
             %{document} when the child '%{relation}' still has documents in it."
           resolution: "Don't attempt to delete the parent %{document} when
             it has children, or change the dependent option on the association."
+        client_session_mismatch:
+          message: "%{model} used within another client's session"
+          summary: >
+            Each model is associated with a client. Each session (transaction)
+            is also associated with a client. You've attempted to create or
+            update a model within a session associated with a different client.
+            This may be a bug in your code.
+          resolution: >
+            Either process the %{model} model outside the enclosing
+            transaction, or open a new transaction for that model before
+            performing the create/update.

data/lib/mongoid/association/accessors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -17,7 +18,7 @@ module Mongoid
       #
       # @param [ String | Symbol ] name The name of the association.
       # @param [ Hash | BSON::ObjectId ] object The id or attributes to use.
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Hash ] selected_fields Fields which were retrieved via #only.
       #   If selected_fields is specified, fields not listed in it will not be
       #   accessible in the built document.
@@ -34,7 +35,7 @@ module Mongoid
       #   person.create_relation(document, association)
       #
       # @param [ Document | Array<Document> ] object The association target.
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Hash ] selected_fields Fields which were retrieved via #only.
       #   If selected_fields is specified, fields not listed in it will not be
       #   accessible in the created association document.
@@ -99,7 +100,7 @@ module Mongoid
       #   document.get_relation(:name, association)
       #
       # @param [ Symbol ] name The name of the association.
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Object ] object The object used to build the association.
       # @param [ true | false ] reload If the association is to be reloaded.
       #
@@ -115,7 +116,7 @@ module Mongoid
         # during binding or when cascading callbacks. Whenever we retrieve
         # associations within the codebase, we use without_autobuild.
         if !without_autobuild? && association.embedded? && attribute_missing?(field_name)
-          raise ActiveModel::MissingAttributeError, "Missing attribute: '#{field_name}'"
+          raise Mongoid::Errors::AttributeNotLoaded.new(self.class, field_name)
         end
 
         if !reload && (value = ivar(name)) != false
@@ -268,7 +269,7 @@ module Mongoid
       #   person.has_game?
       #   person.game?
       #
-      # @param [ Association ] association The association.
+      # @param [ Mongoid::Association::Relatable ] association The association.
       #
       # @return [ Class ] The model being set up.
       def self.define_existence_check!(association)
@@ -290,7 +291,7 @@ module Mongoid
       # @example Set up the getter for the association.
       #   Person.define_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_getter!(association)
@@ -312,7 +313,7 @@ module Mongoid
       # @example Set up the ids getter for the association.
       #   Person.define_ids_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_ids_getter!(association)
@@ -332,7 +333,7 @@ module Mongoid
       # @example Set up the setter for the association.
       #   Person.define_setter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_setter!(association)
@@ -341,12 +342,11 @@ module Mongoid
           klass.re_define_method("#{name}=") do |object|
             without_autobuild do
               if value = get_relation(name, association, object)
-                if value.respond_to?(:substitute)
-                  set_relation(name, value.substitute(object.substitutable))
-                else
-                  value = __build__(name, value, association)
-                  set_relation(name, value.substitute(object.substitutable))
+                if !value.respond_to?(:substitute)
+                  value = __build__(name, value, association) 
                 end
+
+                set_relation(name, value.substitute(object.substitutable))
               else
                 __build__(name, object.substitutable, association)
               end
@@ -364,7 +364,7 @@ module Mongoid
       # @example Set up the id_setter for the association.
       #   Person.define_ids_setter!(association)
       #
-      #  @param [ Association ] association The association for the association.
+      #  @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       #  @return [ Class ] The class being set up.
       def self.define_ids_setter!(association)
@@ -383,7 +383,7 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_builder!(association)
@@ -408,7 +408,7 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_creator!(association)

data/lib/mongoid/association/bindable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -16,7 +17,7 @@ module Mongoid
       #
       # @param [ Document ] base The base of the binding.
       # @param [ Document | Array<Document> ] target The target of the binding.
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       def initialize(base, target, association)
         @_base, @_target, @_association = base, target, association
       end
@@ -119,7 +120,7 @@ module Mongoid
       # @param [ Object ] id The id of the bound document.
       def bind_foreign_key(keyed, id)
         unless keyed.frozen?
-          keyed.you_must(_association.foreign_key_setter, id)
+          try_method(keyed, _association.foreign_key_setter, id)
         end
       end
 
@@ -134,8 +135,8 @@ module Mongoid
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
       def bind_polymorphic_type(typed, name)
-        if _association.type
-          typed.you_must(_association.type_setter, name)
+        if _association.type && !typed.frozen?
+          try_method(typed, _association.type_setter, name)
         end
       end
 
@@ -150,8 +151,8 @@ module Mongoid
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
       def bind_polymorphic_inverse_type(typed, name)
-        if _association.inverse_type
-          typed.you_must(_association.inverse_type_setter, name)
+        if _association.inverse_type && !typed.frozen?
+          try_method(typed, _association.inverse_type_setter, name)
         end
       end
 
@@ -166,8 +167,8 @@ module Mongoid
       # @param [ Document ] doc The base document.
       # @param [ Document ] inverse The inverse document.
       def bind_inverse(doc, inverse)
-        if doc.respond_to?(_association.inverse_setter)
-          doc.you_must(_association.inverse_setter, inverse)
+        if doc.respond_to?(_association.inverse_setter) && !doc.frozen?
+          try_method(doc, _association.inverse_setter, inverse)
         end
       end
 
@@ -222,6 +223,24 @@ module Mongoid
         bind_polymorphic_type(doc, nil)
         bind_inverse(doc, nil)
       end
+
+      # Convenience method to perform +#try+ but return
+      # nil if the method argument is nil.
+      #
+      # @example Call method if it exists.
+      #   object.try_method(:use, "The Force")
+      #
+      # @example Return nil if method argument is nil.
+      #   object.try_method(nil, "The Force") #=> nil
+      #
+      # @param [ String | Symbol ] method_name The method name.
+      # @param [ Object... ] *args The arguments.
+      #
+      # @return [ Object | nil ] The result of the try or nil if the
+      #   method does not exist.
+      def try_method(object, method_name, *args)
+        object.try(method_name, *args) if method_name
+      end
     end
   end
 end

data/lib/mongoid/association/builders.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -39,7 +40,7 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class being set up.
       def self.define_builder!(association)
@@ -63,7 +64,7 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class being set up.
       def self.define_creator!(association)

data/lib/mongoid/association/constrainable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Association

data/lib/mongoid/association/depending.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -19,6 +20,12 @@ module Mongoid
       end
 
       class_methods do
+
+        # Returns all dependent association metadata objects.
+        #
+        # @return [ Array<Mongoid::Association::Relatable> ] The dependent
+        #   association metadata.
+        #
         # @api private
         def _all_dependents
           superclass_dependents = superclass.respond_to?(:_all_dependents) ? superclass._all_dependents : []
@@ -44,7 +51,7 @@ module Mongoid
       # @example Set up cascading information
       #   Mongoid::Association::Depending.define_dependency!(association)
       #
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class of the document.
       def self.define_dependency!(association)
@@ -61,6 +68,14 @@ module Mongoid
         end
       end
 
+      # Validates that an association's dependent strategy is
+      # within the allowed enumeration.
+      #
+      # @param [ Mongoid::Association::Relatable ] association
+      #   The association to validate.
+      #
+      # @raises [ Mongoid::Errors::InvalidDependentStrategy ]
+      #   Error if invalid.
       def self.validate!(association)
         unless STRATEGIES.include?(association.dependent)
           raise Errors::InvalidDependentStrategy.new(association,