mongoid 6.4.4 → 7.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf32387a001233a1704c7c20281e25dfbb8262134114bbdfedef5dcd888032c
-  data.tar.gz: 25fecceb3036b5feb86d572e8994c60a8cbac0c47daabd1307788723bc8090f3
+  metadata.gz: 93d8b658e53d12f1deb7a131e3d58155fead7576955078187f3b3181072c193f
+  data.tar.gz: 35e629224f7495969e5a695a9641043ad61b92d61b57926b1d1956bd2f5e1d7c
 SHA512:
-  metadata.gz: 03be9dcb886f2bc83a7b57a93fecf2bf3e0732668ee173c30d810fb0459cc4ec4eae277717e4bd0695d969ec378d58e4767f5e99ea73b036eb764637da1cb8a6
-  data.tar.gz: fe0e129f059daabb83fd638455ea22fe0da7800b5095400210ee4d71acf6b02d78847f60e8393ae15815fbb57d4753bfbb2be0db76ca2351f75f075d3a65b5c7
+  metadata.gz: 33920733722a4da26c23190788ef198d86d0d3edfcedc3d53bc7364d9abfbda7c54634af875c678757745c1d18b225457ef8e0a5b5711db7e76b93350548d14b
+  data.tar.gz: cb0acea4219ce1972fe67b63f988b0f31197ab44142288e5af4fe84e63f602dbc9b7dcc23edbf54cc5e465288c23346f62d3cf0632e0b37a59fabc6acb1c6925

data/CHANGELOG.md

@@ -547,7 +547,7 @@ child elements.
 
 * \#3432 Fixed mongoization of DateTime losing precision.
 
-* \#3397 Fixed $ne matcher for embedded documents to match server behaviour.
+* \#3397 Fixed $ne matcher for embedded documents to match server behavior.
 
 * \#3352 Allow named scopes named "open" to work through 1-n relations.
 
@@ -1305,8 +1305,8 @@ child elements.
   validation fails. Instead, they get flagged for destruction and then the
   removal occurs upon the parent passing validation and going to persist.
 
-  Note this is a behaviour change, but since the API does not change and
-  the previous behaviour was incorrect and did not match AR this was able
+  Note this is a behavior change, but since the API does not change and
+  the previous behavior was incorrect and did not match AR this was able
   to go into a point release.
 
 ## 3.0.9
@@ -1848,18 +1848,18 @@ child elements.
   set a child on a relation without the proper inverse_of definitions
   due to Mongoid not being able to determine it.
 
-        class Lush
+        class Car
           include Mongoid::Document
-          embeds_one :whiskey, class_name: "Drink"
+          embeds_one :engine, class_name: "Motor"
         end
 
-        class Drink
+        class Motor
           include Mongoid::Document
-          embedded_in :alcoholic, class_name: "Lush"
+          embedded_in :machine, class_name: "Car"
         end
 
-        lush = Lush.new
-        lush.whiskey = Drink.new # raises an InverseNotFound error.
+        car = Car.new
+        car.engine = Motor.new # raises an InverseNotFound error.
 
 * \#1680 Polymorphic relations now use `*_type` keys in lookup queries.
 
@@ -2345,7 +2345,7 @@ child elements.
 
 * \#463 `Document#upsert` is no longer aliased to `Document#save` and now
   actually performs a proper MongoDB upsert command when called. If you
-  were using this method before and want the same behaviour, please switch
+  were using this method before and want the same behavior, please switch
   to `save`.
 
         band = Band.new(name: "Tool")
@@ -2401,7 +2401,7 @@ child elements.
 * \#1972 `added`, `loaded`, and `unloaded` can now be valid scope names on a
   document that is part of a 1-n relation.
 
-* \#1952/#1950 `#all_in` behaviour on embedded documents now properly matches
+* \#1952/#1950 `#all_in` behavior on embedded documents now properly matches
   root documents when passing an empty array. (Hans Hasselberg)
 
 * \#1941/#1939 `Model.find_by` now returns nil if raise not found error is
@@ -3201,7 +3201,7 @@ child elements.
 * \#1273 Mongoid.preload_models now checks if preload configuration option is set,
   where Mongoid.load_models always loads everything. (Ryan McGeary)
 
-* \#1244 Has one relations now adhere to default dependant behaviour.
+* \#1244 Has one relations now adhere to default dependant behavior.
 
 * \#1225 Fixed delayed persistence of embedded documents via $set.
 
@@ -3352,7 +3352,7 @@ validations error from before.
 
 * \#1173 has_many relations no longer delete all documents on a set of the relation
  (= [ doc_one, doc_two ]) but look to the dependent option to determine what
- behaviour should occur. :delete and :destroy will behave as before, :nullify and
+ behavior should occur. :delete and :destroy will behave as before, :nullify and
  no option specified will both nullify the old documents without deleting.
 
 * \#1142, \#767 Embedded relations no longer immediately persist atomically

data/LICENSE

@@ -1,4 +1,5 @@
 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

@@ -1,37 +1,44 @@
 # Mongoid
-[![Build Status](https://travis-ci.org/mongodb/mongoid.svg?branch=master)](https://travis-ci.org/mongodb/mongoid)
 [![Code Climate](https://codeclimate.com/github/mongodb/mongoid.svg)](https://codeclimate.com/github/mongodb/mongoid)
-[![Dependency Status](https://www.versioneye.com/ruby/mongoid/4.0.0/badge.svg)](https://www.versioneye.com/ruby/mongoid/4.0.0)
 
-Mongoid is an ODM (Object-Document-Mapper) framework for MongoDB in Ruby.
+Mongoid is an ODM (Object-Document Mapper) framework for MongoDB in Ruby.
 
-Issues
-------
-
-Issues are now in the [Mongoid Jira project](https://jira.mongodb.org/browse/MONGOID/).
+Documentation
+-------------
 
-Project Tracking
-----------------
+Mongoid has [extensive user documentation](https://docs.mongodb.com/mongoid/current/).
+[API documentation](http://api.mongodb.com/mongoid/current/) is also available.
 
-* [Mongoid Website and Documentation](http://mongoid.org)
-* [Mongoid Google Group](http://groups.google.com/group/mongoid)
-* [Stackoverflow](http://stackoverflow.com/questions/tagged/mongoid)
-* [#mongoid](http://webchat.freenode.net/?channels=mongoid) on freenode IRC
+Mongoid is built on top of the MongoDB Ruby driver which has
+[its own user documentation](https://docs.mongodb.com/ruby-driver/current/).
 
 Compatibility
 -------------
 
-Mongoid is tested against MRI 2.2, 2.3 and JRuby (9.1).
+Mongoid supports and is tested against:
 
-Documentation
--------------
+- MRI 2.3-2.7
+- JRuby 9.2
+- MongoDB server 2.6-4.4
+
+Issues
+------
+
+Please use the [MONGOID project](https://jira.mongodb.org/browse/MONGOID/)
+in MongoDB JIRA to report issues with Mongoid.
+
+Support
+-------
 
-Please see the [MongoDB website](http://docs.mongodb.org/ecosystem/tutorial/ruby-mongoid-tutorial/#ruby-mongoid-tutorial) for up-to-date documentation.
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoid)
+* [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/mongoid-odm)
+* [#mongoid](http://webchat.freenode.net/?channels=mongoid) on Freenode IRC
 
 License
 -------
 
-Copyright (c) 2009-2017 Durran Jordan
+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/Rakefile

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "bundler"
+require "bundler/gem_tasks"
 Bundler.setup
 
 require "rake"
@@ -7,6 +10,9 @@ require "rspec/core/rake_task"
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "mongoid/version"
 
+tasks = Rake.application.instance_variable_get('@tasks')
+tasks['release:do'] = tasks.delete('release')
+
 task :gem => :build
 task :build do
   system "gem build mongoid.gemspec"
@@ -16,11 +22,8 @@ task :install => :build do
   system "sudo gem install mongoid-#{Mongoid::VERSION}.gem"
 end
 
-task :release => :build do
-  system "git tag -a v#{Mongoid::VERSION} -m 'Tagging #{Mongoid::VERSION}'"
-  system "git push --tags"
-  system "gem push mongoid-#{Mongoid::VERSION}.gem"
-  system "rm mongoid-#{Mongoid::VERSION}.gem"
+task :release do
+  raise "Please use ./release.sh to release"
 end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
@@ -33,3 +36,23 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
 end
 
 task :default => :spec
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('yard-docs', Mongoid::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
+  end
+end
+
+namespace :release do
+  task :check_private_key do
+    unless File.exist?('gem-private_key.pem')
+      raise "No private key present, cannot release"
+    end
+  end
+end

data/lib/config/locales/en.yml

@@ -8,15 +8,15 @@ en:
         summary_title: "summary"
         resolution_title: "resolution"
         ambiguous_relationship:
-          message: "Ambiguous relations %{candidates} defined on %{klass}."
+          message: "Ambiguous associations %{candidates} defined on %{klass}."
           summary:
-            "When Mongoid attempts to set an inverse document of a relation
-            in memory, it needs to know which relation it belongs to. When
+            "When Mongoid attempts to set an inverse document of an association
+            in memory, it needs to know which association it belongs to. When
             setting %{name}, Mongoid looked on the class %{inverse}
-            for a matching relation, but multiples were found that could
+            for a matching association, but multiples were found that could
             potentially match: %{candidates}."
-          resolution: "On the %{name} relation on %{inverse} you must add an
-            :inverse_of option to specify the exact relationship on %{klass}
+          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}."
         callbacks:
           message: "Calling %{method} on %{klass} resulted in a false return
@@ -26,6 +26,15 @@ en:
             since the document did not actually get saved."
           resolution: "Double check all before callbacks to make sure they are
             not unintentionally returning false."
+        criteria_argument_required:
+          message: "Calling Criteria methods with nil arguments is not allowed."
+          summary: "Arguments to Criteria methods cannot be nil, and most
+            Criteria methods require at least one argument. Only logical
+            operations (and, or, nor and not), `all' and `where' can be called
+            without arguments.
+            The method that was called with nil argument was: %{query_method}."
+          resolution: "Invoke Criteria methods with non-nil arguments or omit
+            the respective invocations."
         calling_document_find_with_nil_is_invalid:
           message: "Calling Document.find with nil is invalid."
           summary: "Document.find expects the parameters to be 1 or more ids, and
@@ -62,9 +71,9 @@ en:
             which will cause a nil to be returned instead of raising this error."
         eager_load:
           message: "Eager loading :%{name} is not supported since it is a
-            polymorphic belongs_to relation."
+            polymorphic belongs_to association."
           summary: "Mongoid cannot currently determine the classes it needs to
-            eager load when the relation is polymorphic. The parents reside in
+            eager load when the association is polymorphic. The parents reside in
             different collections so a simple id lookup is not sufficient enough."
           resolution: "Don't attempt to perform this action and have patience,
             maybe this will be supported in the future."
@@ -91,6 +100,11 @@ en:
             expecting the option to be there, please consult the following page
             with repect to Mongoid's configuration:\n\n
             \_\_http://mongoid.org/en/mongoid/docs/installation.html"
+        invalid_dependent_strategy:
+          message: "Invalid dependent strategy: %{invalid_strategy}."
+          summary: "An invalid dependent strategy was defined for the association:
+            %{association}. The valid strategies are: %{valid_strategies}."
+          resolution: "Change the dependent strategy to one of the valid types."
         invalid_field:
           message: "Defining a field named '%{name}' is not allowed."
           summary: "Defining this field would override the method '%{name}',
@@ -107,7 +121,7 @@ en:
         invalid_field_option:
           message: "Invalid option :%{option} provided for field :%{name}."
           summary: "Mongoid requires that you only provide valid options on each
-            field definition in order to prevent unexpected behaviour later on."
+            field definition in order to prevent unexpected behavior later on."
           resolution: "When defining the field :%{name} on '%{klass}', please provide
             valid options for the field. These are currently: %{valid}. If you
             meant to define a custom field option, please do so first like so:\n\n
@@ -121,9 +135,9 @@ en:
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments
-            to %{klass}.includes that are the names of relations on the %{klass}."
+            to %{klass}.includes that are the names of associations on the %{klass}."
           resolution: "Ensure that each parameter passed to %{klass}.includes is
-            a valid name of a relation on the %{klass} model. These are: %{relations}."
+            a valid name of an association on the %{klass} model. These are: %{relations}."
         invalid_index:
           message: "Invalid index specification on %{klass}: %{spec}, %{options}"
           summary: "Indexes in Mongoid are defined as a hash of field name and
@@ -160,8 +174,8 @@ en:
             \_\_\_\_index({ location: '2d' }, { background: true })\n
             \_\_end\n\n"
         invalid_options:
-          message: "Invalid option :%{invalid} provided to relation :%{name}."
-          summary: "Mongoid checks the options that are passed to the relation
+          message: "Invalid option :%{invalid} provided to association :%{name}."
+          summary: "Mongoid checks the options that are passed to the association
             macros to ensure that no ill side effects occur by letting something
             slip by."
           resolution: "Valid options are: %{valid}, make sure these are the ones
@@ -174,7 +188,7 @@ en:
             root path assigned."
           resolution: "Most likely your embedded model, %{klass} is also
             referenced via a has_many from a root document in another
-            collection. Double check the relation definitions and fix any
+            collection. Double check the association definitions and fix any
             instances where embedded documents are improperly referenced
             from other collections."
         invalid_persistence_option:
@@ -184,8 +198,8 @@ en:
           resolution: "Valid options are: %{valid}, make sure these are the ones
              you are using."
         invalid_relation:
-          message: "Defining a relation named '%{name}' is not allowed."
-          summary: "Defining this relation would override the method '%{name}',
+          message: "Defining an association named '%{name}' is not allowed."
+          summary: "Defining this association would override the method '%{name}',
             which would cause issues with expectations around the original
             method and cause extremely hard to debug issues. The original
             method was defined in:\n
@@ -196,6 +210,11 @@ en:
             allowed, and don't use these names. These include names that also
             conflict with core Ruby methods on Object, Module, Enumerable, or
             included gems that inject methods into these or Mongoid internals."
+        invalid_relation_option:
+          message: "Invalid association option :%{option} for association '%{name}' on class
+            %{klass}."
+          summary: "An invalid option was provided for an association."
+          resolution: "Valid options are: %{valid_options}, make sure you use only those."
         invalid_scope:
           message: "Defining a scope of value %{value} on %{klass} is not
             allowed."
@@ -230,7 +249,7 @@ en:
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_store_in collection: 'artists', database: 'secondary'\n
+            \_\_\_\_store_in collection: 'artists', database: 'music'\n
             \_\_end\n\n"
         invalid_storage_parent:
           message: "Invalid store_in call on class %{klass}."
@@ -251,35 +270,35 @@ en:
           message: "When adding a(n) %{klass} to %{base}#%{name}, Mongoid could
             not determine the inverse foreign key to set. The attempted key was
             '%{inverse}'."
-          summary: "When adding a document to a relation, Mongoid attempts
-            to link the newly added document to the base of the relation in
+          summary: "When adding a document to an association, Mongoid attempts
+            to link the newly added document to the base of the association in
             memory, as well as set the foreign key to link them on the
             database side. In this case Mongoid could not determine what the
             inverse foreign key was."
           resolution: "If an inverse is not required, like a belongs_to or
             has_and_belongs_to_many, ensure that :inverse_of => nil is set
-            on the relation. If the inverse is needed, most likely the
-            inverse cannot be figured out from the names of the relations and
-            you will need to explicitly tell Mongoid on the relation what
+            on the association. If the inverse is needed, most likely the
+            inverse cannot be figured out from the names of the associations and
+            you will need to explicitly tell Mongoid on the association what
             the inverse is.\n\n
             Example:\n
-            \_\_class Lush\n
+            \_\_class Car\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_has_one :whiskey, class_name: \"Drink\", inverse_of: :alcoholic\n
+            \_\_\_\_has_one :engine, class_name: \"Motor\", inverse_of: :machine\n
             \_\_end\n\n
-            \_\_class Drink\n
+            \_\_class Motor\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_belongs_to :alcoholic, class_name: \"Lush\", inverse_of: :whiskey\n
+            \_\_\_\_belongs_to :machine, class_name: \"Car\", inverse_of: :engine\n
             \_\_end"
         invalid_set_polymorphic_relation:
           message: "The %{name} attribute can't be set to an instance of
-            %{other_klass} as %{other_klass} has multiple relations referencing
+            %{other_klass} as %{other_klass} has multiple associations referencing
             %{klass} as %{name}."
-          summary: "If the parent class of a polymorphic relation has multiple
-            definitions for the same relation, the values must be set from the
+          summary: "If the parent class of a polymorphic association has multiple
+            definitions for the same association, the values must be set from the
             parent side and not the child side since Mongoid cannot determine
-            from the child side which relation to go in."
-          resolution: "Set the values from the parent, or redefine the relation
+            from the child side which association to go in."
+          resolution: "Set the values from the parent, or redefine the association
             with only a single definition in the parent."
         invalid_value:
           message: "Value of type %{value_class} cannot be written to a field of type %{field_class}"
@@ -287,7 +306,7 @@ en:
           resolution: "Verify if the value to be set correspond to field definition"
         mixed_relations:
           message: "Referencing a(n) %{embedded} document from the %{root}
-            document via a relational association is not allowed since the
+            document via a non-embedded association is not allowed since the
             %{embedded} is embedded."
           summary: "In order to properly access a(n) %{embedded} from %{root}
             the reference would need to go through the root document of
@@ -307,15 +326,15 @@ en:
           resolution: "Provide either only a uri as configuration or only
             standard options."
         nested_attributes_metadata_not_found:
-          message: "Could not find metadata for relation '%{name}' on model:
+          message: "Could not find metadata for association '%{name}' on model:
             %{klass}."
-          summary: "When defining nested attributes for a relation, Mongoid
-            needs to access the metadata for the relation '%{name}' in order
+          summary: "When defining nested attributes for an association, Mongoid
+            needs to access the metadata for the association '%{name}' in order
             if add autosave functionality to it, if applicable. Either no
-            relation named '%{name}' could be found, or the relation had not
+            association named '%{name}' could be found, or the association had not
             been defined yet."
-          resolution: "Make sure that there is a relation defined named
-            '%{name}' on %{klass} or that the relation definition comes before
+          resolution: "Make sure that there is an association defined named
+            '%{name}' on %{klass} or that the association definition comes before
             the accepts_nested_attributes_for macro in the model - order
             matters so that Mongoid has access to the metadata.\n\n
             Example:\n
@@ -363,16 +382,16 @@ en:
             \_\_reduce:  'collection-name'\n\n"
         no_metadata:
           message: "Metadata not found for document of type %{klass}."
-          summary: "Mongoid sets the metadata of a relation on the document
-            when it is either loaded from within the relation, or added to
+          summary: "Mongoid sets the metadata of an association on the document
+            when it is either loaded from within the association, or added to
             one. The presence of the metadata is required in order to
-            provide various functionality around relations. Most likely you
+            provide various functionality around associations. Most likely you
             are getting this error because the document is embedded and was
             attempted to be persisted without being associated with a parent,
-            or the relation was not properly defined."
-          resolution: "Ensure that your relations on the %{klass} model
-            are all properly defined, and that the inverse relations
-            are also properly defined. Embedded relations must have both the
+            or the association was not properly defined."
+          resolution: "Ensure that your associations on the %{klass} model
+            are all properly defined, and that the inverse associations
+            are also properly defined. Embedded associations must have both the
             parent (embeds_one/embeds_many) and the inverse (embedded_in)
             present in order to work properly."
         no_parent:
@@ -383,9 +402,9 @@ en:
             most likely caused by either calling %{klass}.create or
             %{klass}.create! without setting the parent document as an
             attribute."
-          resolution: "Ensure that you've set the parent relation if
+          resolution: "Ensure that you've set the parent association if
             instantiating the embedded document directly, or always create new
-            embedded documents via the parent relation."
+            embedded documents via the parent association."
         no_client_config:
           message: "No configuration could be found for a client named
             '%{name}'."
@@ -494,10 +513,17 @@ en:
             attributes hash, and is raised instead of getting a NoMethodError."
           resolution: "You can include Mongoid::Attributes::Dynamic if you
             expect to be writing values for undefined fields often."
+        unknown_model:
+          message: "Attempted to instantiate an object of the unknown Model '%{klass}'."
+          summary: "A document with the value '%{value}' at the key '_type' was used to
+            instantiate a model object but Mongoid cannot find this Class."
+          resolution: "The _type field is a reserved one used by Mongoid to determine the
+            class for instantiating an object. Please don't save data in this field or ensure
+            that any values in this field correspond to valid Models."
         unsaved_document:
           message: "Attempted to save %{document} before the parent %{base}."
           summary: "You cannot call create or create! through the
-            relation (%{document}) whose parent (%{base}) is
+            association (%{document}) whose parent (%{base}) is
             not already saved. This would cause the database to be out of sync
             since the child could potentially reference a nonexistent parent."
           resolution: "Make sure to only use create or create! when the parent
@@ -509,7 +535,7 @@ en:
             #where criterion on embedded documents. Since %{klass} is embedded,
             the expression %{javascript} is not allowed."
           resolution: "Please provide a standard hash to #where when the criteria
-            is for an embedded relation."
+            is for an embedded association."
         validations:
           message: "Validation of %{document} failed."
           summary: "The following errors were found: %{errors}"
@@ -521,4 +547,4 @@ en:
             Mongoid will raise an error when attempting to delete the
             %{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 relation."
+            it has children, or change the dependent option on the association."