mongoid 7.0.4 → 7.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ae228df96e11fe59977a8d1af1bb0e86597fe5ee31d8cbe257a077d6e87d4f
-  data.tar.gz: b8face8e682359ca47c26c0dc168ab1a99762769176fd2f8796ae472a341cd76
+  metadata.gz: 5ad9fbedf524c291d800a33349aed2f382c34bbe7b2db4417b7fc73f4c6b0ced
+  data.tar.gz: 2dc25b9b97f8a9d56249ea690affb49537f3d8cc73d03e149abf5b3f9511f5bf
 SHA512:
-  metadata.gz: 1aafc53e49a0576a7bfb081bca208629ba7323c1a52468e0279644b0b9c2a9d4015c63d35cdf1f16b0967056ed976d015638fab512bce7a221acfeda75c867ed
-  data.tar.gz: 0c3e7557c424ccd5a95d3e5c4249e4a45a31f74577be2ba7cfac70d67d3226cd00b0b655e7f9d576086a0fc18c7b9d7bf37c57e8a06fb07131a3bec99e85fe8a
+  metadata.gz: 86f6b6b3df1aaa98de5344f58e152b0a05b6f0ea21153e7fadd4a1d3b1ba74bed9a7b967ab608ce01dc2cb401c81e153f69569f5e8d19a96dcc953be27b16823
+  data.tar.gz: e99a2501707a844f35a4eecc827163f871b77fd2f681e347e9bede2b0708dab8bdec0ce8520304f01f475c63cc33fc0216bd7d8b7e98556f5f6b696b8682ffe1

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

@@ -14,7 +14,7 @@ Project Tracking
 ----------------
 
 * [Mongoid Website and Documentation](http://mongoid.org)
-* [Mongoid Google Group](http://groups.google.com/group/mongoid)
+* [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/mongoid-odm)
 * [Stackoverflow](http://stackoverflow.com/questions/tagged/mongoid)
 * [#mongoid](http://webchat.freenode.net/?channels=mongoid) on freenode IRC
 
@@ -31,7 +31,8 @@ Please see the [MongoDB website](http://docs.mongodb.org/ecosystem/tutorial/ruby
 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,5 @@
 require "bundler"
+require "bundler/gem_tasks"
 Bundler.setup
 
 require "rake"
@@ -7,6 +8,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"
@@ -33,3 +37,25 @@ 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
+
+task :release => ['release:check_private_key', 'release:do']

data/lib/mongoid.rb

@@ -13,6 +13,7 @@ require "active_support/time_with_zone"
 require "active_model"
 
 require "mongo"
+require 'mongo/active_support'
 
 require "mongoid/version"
 require "mongoid/config"
@@ -101,5 +102,5 @@ module Mongoid
   #   Mongoid.database = Mongo::Connection.new.db("test")
   #
   # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ] << { to: Config }))
+  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ]), to: Config)
 end

data/lib/mongoid/association/embedded/embeds_many.rb

@@ -197,7 +197,8 @@ module Mongoid
         def determine_inverses(other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-                rel.relation_class_name == inverse_class_name
+              # https://jira.mongodb.org/browse/MONGOID-4882
+              rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
           end
           if matches.size > 1
             raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)

data/lib/mongoid/association/embedded/embeds_one.rb

@@ -159,7 +159,8 @@ module Mongoid
         def determine_inverses(other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-                rel.relation_class_name == inverse_class_name
+              # https://jira.mongodb.org/browse/MONGOID-4882
+              rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
 
           end
           if matches.size > 1

data/lib/mongoid/association/proxy.rb

@@ -12,7 +12,7 @@ module Mongoid
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
         undef_method(method) unless
-          method =~ /^(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
+          method =~ /\A(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)\z/
       end
 
       include Threaded::Lifecycle

data/lib/mongoid/atomic.rb

@@ -36,7 +36,9 @@ module Mongoid
     # @since 2.2.0
     def add_atomic_pull(document)
       document.flagged_for_destroy = true
-      (delayed_atomic_pulls[document.association_name.to_s] ||= []).push(document)
+      key = document.association_name.to_s
+      delayed_atomic_pulls[key] ||= []
+      delayed_atomic_pulls[key] << document
     end
 
     # Add an atomic unset for the document.
@@ -51,7 +53,9 @@ module Mongoid
     # @since 3.0.0
     def add_atomic_unset(document)
       document.flagged_for_destroy = true
-      (delayed_atomic_unsets[document.association_name.to_s] ||= []).push(document)
+      key = document.association_name.to_s
+      delayed_atomic_unsets[key] ||= []
+      delayed_atomic_unsets[key] << document
     end
 
     # Returns path of the attribute for modification
@@ -189,7 +193,13 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_paths
-      @atomic_paths ||= _association ? _association.path(self) : Atomic::Paths::Root.new(self)
+      @atomic_paths ||= begin
+        if _association
+          _association.path(self)
+        else
+          Atomic::Paths::Root.new(self)
+        end
+      end
     end
 
     # Get all the attributes that need to be pulled.

data/lib/mongoid/atomic/paths/embedded.rb

@@ -20,7 +20,7 @@ module Mongoid
         #
         # @since 2.1.0
         def path
-          @path ||= position.sub(/\.\d+$/, "")
+          @path ||= position.sub(/\.\d+\z/, "")
         end
       end
     end

data/lib/mongoid/attributes.rb

@@ -157,21 +157,21 @@ module Mongoid
     #
     # @since 1.0.0
     def write_attribute(name, value)
-      access = database_field_name(name)
-      if attribute_writable?(access)
+      field_name = database_field_name(name)
+      if attribute_writable?(field_name)
         _assigning do
-          validate_attribute_value(access, value)
-          localized = fields[access].try(:localized?)
+          validate_attribute_value(field_name, value)
+          localized = fields[field_name].try(:localized?)
           attributes_before_type_cast[name.to_s] = value
-          typed_value = typed_value_for(access, value)
-          unless attributes[access] == typed_value || attribute_changed?(access)
-            attribute_will_change!(access)
+          typed_value = typed_value_for(field_name, value)
+          unless attributes[field_name] == typed_value || attribute_changed?(field_name)
+            attribute_will_change!(field_name)
           end
           if localized
-            attributes[access] ||= {}
-            attributes[access].merge!(typed_value)
+            attributes[field_name] ||= {}
+            attributes[field_name].merge!(typed_value)
           else
-            attributes[access] = typed_value
+            attributes[field_name] = typed_value
           end
           typed_value
         end
@@ -337,20 +337,28 @@ module Mongoid
 
     private
 
-    # Validates an attribute value. This provides validation checking if
-    # the value is valid for given a field.
-    # For now, only Hash and Array fields are validated.
+    # Validates an attribute value as being assignable to the specified field.
     #
-    # @param [ String, Symbol ] access The name of the attribute to validate.
-    # @param [ Object ] value The to be validated.
+    # For now, only Hash and Array fields are validated, and the value is
+    # being checked to be of an appropriate type (i.e. either Hash or Array,
+    # respectively, or nil).
+    #
+    # This method takes the name of the field as stored in the document
+    # in the database, not (necessarily) the Ruby method name used to read/write
+    # the said field.
+    #
+    # @param [ String, Symbol ] field_name The name of the field.
+    # @param [ Object ] value The value to be validated.
     #
     # @since 3.0.10
-    def validate_attribute_value(access, value)
-      return unless fields[access] && value
+    def validate_attribute_value(field_name, value)
+      return if value.nil?
+      field = fields[field_name]
+      return unless field
       validatable_types = [ Hash, Array ]
-      if validatable_types.include? fields[access].type
-        unless value.is_a? fields[access].type
-          raise Mongoid::Errors::InvalidValue.new(fields[access].type, value.class)
+      if validatable_types.include?(field.type)
+        unless value.is_a?(field.type)
+          raise Mongoid::Errors::InvalidValue.new(field.type, value.class)
         end
       end
     end

data/lib/mongoid/attributes/dynamic.rb

@@ -38,12 +38,13 @@ module Mongoid
       # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
-        class_eval <<-READER, __FILE__, __LINE__ + 1
-          def #{name}
-            attribute_will_change!(#{name.inspect})
-            read_raw_attribute(#{name.inspect})
+
+        class_eval do
+          define_method(name) do
+            attribute_will_change!(name)
+            read_raw_attribute(name)
           end
-        READER
+        end
       end
 
       # Define a reader method for a dynamic attribute before type cast.
@@ -57,12 +58,12 @@ module Mongoid
       #
       # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
-        class_eval <<-READER, __FILE__, __LINE__ + 1
-          def #{name}_before_type_cast
-            attribute_will_change!(#{name.inspect})
-            read_attribute_before_type_cast(#{name.inspect})
+        class_eval do
+          define_method("#{name}_before_type_cast") do
+            attribute_will_change!(name)
+            read_attribute_before_type_cast(name)
           end
-        READER
+        end
       end
 
       # Define a writer method for a dynamic attribute.
@@ -78,11 +79,11 @@ module Mongoid
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
-        class_eval <<-WRITER, __FILE__, __LINE__ + 1
-          def #{name}=(value)
-            write_attribute(#{name.inspect}, value)
+        class_eval do
+          define_method("#{name}=") do |value|
+            write_attribute(name, value)
           end
-        WRITER
+        end
       end
 
       # If the attribute is dynamic, add a field for it with a type of object

data/lib/mongoid/clients/sessions.rb

@@ -38,12 +38,20 @@ module Mongoid
       #
       # @since 6.4.0
       def with_session(options = {})
-        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+        if Threaded.get_session
+          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting)
+        end
         session = persistence_context.client.start_session(options)
         Threaded.set_session(session)
         yield(session)
       rescue Mongo::Error::InvalidSession => ex
-        if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+        if
+          # Driver 2.13.0+
+          defined?(Mongo::Error::SessionsNotSupported) &&
+            Mongo::Error::SessionsNotSupported === ex ||
+          # Legacy drivers
+          ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+        then
           raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
         end
         raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
@@ -89,12 +97,20 @@ module Mongoid
         #
         # @since 6.4.0
         def with_session(options = {})
-          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+          if Threaded.get_session
+            raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting)
+          end
           session = persistence_context.client.start_session(options)
           Threaded.set_session(session)
           yield(session)
         rescue Mongo::Error::InvalidSession => ex
-          if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+          if
+            # Driver 2.13.0+
+            defined?(Mongo::Error::SessionsNotSupported) &&
+              Mongo::Error::SessionsNotSupported === ex ||
+            # Legacy drivers
+            ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+          then
             raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
           end
           raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)

data/lib/mongoid/config/environment.rb

@@ -6,35 +6,48 @@ module Mongoid
     module Environment
       extend self
 
-      # Get the name of the environment that we are running under. This first
-      # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
-      # and if none of those are found raises an error.
+      # Get the name of the environment that Mongoid is running under.
+      #
+      # Uses the following sources in order:
+      # - If +::Rails+ is defined, +Rails.env+.
+      # - If +::Sinatra+ is defined, +Sinatra::Base.environment+.
+      # - +RACK_ENV+
+      # - +MONGOID_ENV*
       #
       # @example Get the env name.
       #   Environment.env_name
       #
-      # @raise [ Errors::NoEnvironment ] If no environment was set.
+      # @raise [ Errors::NoEnvironment ] If environment name cannot be
+      #   determined because none of the sources was set.
       #
       # @return [ String ] The name of the current environment.
       #
       # @since 2.3.0
+      # @api public
       def env_name
-        return Rails.env if defined?(Rails) && Rails.respond_to?(:env)
-        return Sinatra::Base.environment.to_s if defined?(Sinatra)
-        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] || raise(Errors::NoEnvironment.new)
+        if defined?(::Rails)
+          return ::Rails.env
+        end
+        if defined?(::Sinatra)
+          return ::Sinatra::Base.environment.to_s
+        end
+        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] or raise Errors::NoEnvironment
       end
 
       # Load the yaml from the provided path and return the settings for the
-      # current environment.
+      # specified environment, or for the current Mongoid environment.
       #
       # @example Load the yaml.
       #   Environment.load_yaml("/work/mongoid.yml")
       #
       # @param [ String ] path The location of the file.
+      # @param [ String | Symbol ] environment Optional environment name to
+      #   override the current Mongoid environment.
       #
       # @return [ Hash ] The settings.
       #
       # @since 2.3.0
+      # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
         YAML.load(ERB.new(File.new(path).read).result)[env]

data/lib/mongoid/criteria.rb

@@ -435,7 +435,13 @@ module Mongoid
     #
     # @since 3.1.0
     def for_js(javascript, scope = {})
-      js_query(BSON::CodeWithScope.new(javascript, scope))
+      code = if scope.empty?
+        # CodeWithScope is not supported for $where as of MongoDB 4.4
+        BSON::Code.new(javascript)
+      else
+        BSON::CodeWithScope.new(javascript, scope)
+      end
+      js_query(code)
     end
 
     private

data/lib/mongoid/criteria/modifiable.rb

@@ -3,6 +3,10 @@ module Mongoid
   class Criteria
     module Modifiable
 
+      # @attribute [r] create_attrs Additional attributes to add to the Document upon creation.
+      # @api private
+      attr_reader :create_attrs
+
       # Build a document given the selector and return it.
       # Complex criteria, such as $in and $or operations will get ignored.
       #
@@ -57,6 +61,9 @@ module Mongoid
 
       # Define attributes with which new documents will be created.
       #
+      # Note that if `find_or_create_by` is called after this in a method chain, the attributes in
+      # the query will override those from this method.
+      #
       # @example Define attributes to be used when a new document is created.
       #   Person.create_with(job: 'Engineer').find_or_create_by(employer: 'MongoDB')
       #
@@ -64,7 +71,10 @@ module Mongoid
       #
       # @since 5.1.0
       def create_with(attrs = {})
-        where(selector.merge(attrs))
+        tap do
+          @create_attrs ||= {}
+          @create_attrs.update(attrs)
+        end
       end
 
       # Find the first +Document+ given the conditions, or creates a new document
@@ -172,7 +182,8 @@ module Mongoid
       #
       # @since 3.0.0
       def create_document(method, attrs = nil, &block)
-        attributes = selector.reduce(attrs ? attrs.dup : {}) do |hash, (key, value)|
+        attrs = (create_attrs || {}).merge(attrs || {})
+        attributes = selector.reduce(attrs) do |hash, (key, value)|
           unless invalid_key?(hash, key) || invalid_embedded_doc?(value)
             hash[key] = value
           end