mongoid 9.0.0 → 9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b7f297f31cb9dbf9e703769a789969ef5de77ba9f7b0ebf998c0aec1c76524
-  data.tar.gz: 0aeb2382db008ef20fe7635546da3c13df040933b31005c859747d8cd16247f9
+  metadata.gz: f756ccb6822c09519cb0e833a2d3bd2edf5b5a0abf3f3c29205a756682e5d954
+  data.tar.gz: 7d44016955b7e2e90d2dc07b2142cc6c79bacfb83831705f26fdafc773e17e7c
 SHA512:
-  metadata.gz: de6b4d0dbf469baaa5900cbd968a82d74d3eaf1f2b52cc002ddbb37f1531a343c0b5e48a54b47e554a81a1389c7daf43653aa9338653fa7eb7c171d309dd2990
-  data.tar.gz: 1202e0a37c944780c9b9b7ffca7a89736df81d7dd8757bfd0c2c2ec6723e7ee1ebc088feeca7479a1103fc3290ff679282bc5241cf67335505e56e08a0fee1d6
+  metadata.gz: e69bc7c2b6031330346265b5c6cdc8d11909fd1204e32727845e3220c6f105dde407006635f31491df9857597711f610a688818dfaa3bc32f27525e2574ce29d
+  data.tar.gz: 259996128cd10553af4972c6b40f5a8ac537158eeaa1cd012bbc9e6d90d67ad745def51fbd47bafaffe9330324967695e45787732446b305d5bdd13338b94075

data/README.md

@@ -14,6 +14,8 @@ Mongoid has [extensive user documentation](https://www.mongodb.com/docs/mongoid/
 Mongoid is built on top of the MongoDB Ruby driver which has
 [its own user documentation](https://www.mongodb.com/docs/ruby-driver/current/).
 
+High-level Mongoid documentation including tutorials and the reference that were in the docs folder can now be found at the docs-mongoid repository, [here](https://github.com/mongodb/docs-mongoid).
+
 Compatibility
 -------------
 

data/Rakefile

@@ -2,7 +2,6 @@
 # rubocop:todo all
 
 require "bundler"
-require "bundler/gem_tasks"
 Bundler.setup
 
 ROOT = File.expand_path(File.join(File.dirname(__FILE__)))
@@ -11,25 +10,53 @@ $: << File.join(ROOT, 'spec/shared/lib')
 
 require "rake"
 require "rspec/core/rake_task"
-require 'mrss/spec_organizer'
 
-$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
+# stands in for the Bundler-provided `build` task, which builds the
+# gem for this project. Our release process builds the gems in a
+# particular way, in a GitHub action. This task is just to help remind
+# developers of that fact.
 task :build do
-  system "gem build mongoid.gemspec"
+  abort <<~WARNING
+    `rake build` does nothing in this project. The gem must be built via
+    the `Mongoid Release` action on GitHub, which is triggered manually when
+    a new release is ready.
+  WARNING
 end
 
-task :install => :build do
-  system "sudo gem install mongoid-#{Mongoid::VERSION}.gem"
+# `rake version` is used by the deployment system so get the release version
+# of the product beng deployed. It must do nothing more than just print the
+# product version number.
+# 
+# See the mongodb-labs/driver-github-tools/ruby/publish Github action.
+desc "Print the current value of Mongoid::VERSION"
+task :version do
+  require 'mongoid/version'
+
+  puts Mongoid::VERSION
 end
 
+# overrides the default Bundler-provided `release` task, which also
+# builds the gem. Our release process assumes the gem has already
+# been built (and signed via GPG), so we just need `rake release` to
+# push the gem to rubygems.
 task :release do
-  raise "Please use ./release.sh to release"
+  require 'mongoid/version'
+
+  if ENV['GITHUB_ACTION'].nil?
+    abort <<~WARNING
+      `rake release` must be invoked from the `Mongoid Release` GitHub action,
+      and must not be invoked locally. This ensures the gem is properly signed
+      and distributed by the appropriate user.
+
+      Note that it is the `rubygems/release-gem@v1` step in the `Mongoid Release`
+      action that invokes this task. Do not rename or remove this task, or the
+      release-gem step will fail. Reimplement this task with caution.
+
+      mongoid-#{Mongoid::VERSION}.gem was NOT pushed to RubyGems.
+    WARNING
+  end
+
+  system 'gem', 'push', "mongoid-#{Mongoid::VERSION}.gem"
 end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
@@ -96,6 +123,8 @@ RUN_PRIORITY = %i(
 )
 
 def spec_organizer
+  require 'mrss/spec_organizer'
+
   Mrss::SpecOrganizer.new(
     root: ROOT,
     classifiers: CLASSIFIERS,
@@ -131,16 +160,10 @@ task :docs => 'docs:yard'
 namespace :docs do
   desc "Generate yard documentation"
   task :yard do
+    require "mongoid/version"
+
     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

@@ -140,6 +140,10 @@ en:
             A collation option is only supported if the query is executed on a MongoDB server
             with version >= 3.4."
           resolution: "Remove the collation option from the query."
+        invalid_around_callback:
+          message: "An around callback must contain a yield in its definition."
+          summary: "The block needs to be yielded to for around callbacks to function as intended."
+          resolution: "Ensure there is a yield statement inside the body of the around callback."
         invalid_async_query_executor:
           message: "Invalid async_query_executor option: %{executor}."
           summary: "A invalid async query executor was specified.

data/lib/mongoid/atomic_update_preparer.rb

@@ -25,7 +25,7 @@ module Mongoid
           if key.to_s.start_with?('$')
             (atomic_updates[key] ||= {}).update(prepare_operation(klass, key, value))
           else
-            (atomic_updates['$set'] ||= {})[key] = mongoize_for(key, klass, key, value)
+            (atomic_updates['$set'] ||= {})[key] = mongoize_for('$set', klass, key, value)
           end
         end
       end
@@ -43,24 +43,25 @@ module Mongoid
       def prepare_operation(klass, key, value)
         value.each_with_object({}) do |(key2, value2), hash|
           key2 = klass.database_field_name(key2)
-          hash[key2] = value_for(key, klass, value2)
+          hash[key2] = value_for(key, klass, key2, value2)
         end
       end
 
       # Get the value for the provided operator, klass, key and value.
       #
-      # This is necessary for special cases like $rename, $addToSet and $push.
+      # This is necessary for special cases like $rename, $addToSet, $push, $pull and $pop.
       #
       # @param [ String ] operator The operator.
       # @param [ Class ] klass The model class.
+      # @param [ String | Symbol ] key The field key.
       # @param [ Object ] value The original value.
       #
       # @return [ Object ] Value prepared for the provided operator.
-      def value_for(operator, klass, value)
+      def value_for(operator, klass, key, value)
         case operator
         when '$rename' then value.to_s
-        when '$addToSet', '$push' then value.mongoize
-        else mongoize_for(operator, klass, operator, value)
+        when '$addToSet', '$push', '$pull', '$pop' then value.mongoize
+        else mongoize_for(operator, klass, key, value)
         end
       end
 

data/lib/mongoid/config.rb

@@ -171,6 +171,15 @@ module Mongoid
     # See https://jira.mongodb.org/browse/MONGOID-5658 for more details.
     option :around_callbacks_for_embeds, default: false
 
+    # When this flag is false, named scopes cannot unset a default scope.
+    # This is the traditional (and default) behavior in Mongoid 9 and earlier.
+    #
+    # Setting this flag to true will allow named scopes to unset the default
+    # scope. This will be the default in Mongoid 10.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5785 for more details.
+    option :allow_scopes_to_unset_default_scope, default: false
+
     # Returns the Config singleton, for use in the configure DSL.
     #
     # @return [ self ] The Config singleton.

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -90,11 +90,12 @@ module Mongoid
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol ] field The field to sum.
+        # @param [ Symbol | Numeric ] field The field to sum, or the intial
+        #   value of the sum when a block is given.
         #
         # @return [ Numeric ] The sum value.
         def sum(field = nil)
-          return super() if block_given?
+          return super(field || 0) if block_given?
 
           aggregate_by(field, :sum) || 0
         end

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -96,11 +96,14 @@ module Mongoid
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol ] field The field to sum.
+        # @param [ Symbol | Numeric ] field The field to sum, or the initial
+        #    value of the sum when a block is given.
         #
         # @return [ Float ] The sum value.
         def sum(field = nil)
-          block_given? ? super() : aggregates(field)["sum"] || 0
+          return super(field || 0) if block_given?
+
+          aggregates(field)["sum"] || 0
         end
 
         private

data/lib/mongoid/criteria/findable.rb

@@ -169,12 +169,12 @@ module Mongoid
         args.size > 1 || !args.first.is_a?(Hash) && args.first.resizable?
       end
 
-      # Convenience method of raising an invalid options error.
+      # Convenience method of raising an invalid find error.
       #
       # @example Raise the error.
       #   criteria.raise_invalid
       #
-      # @raise [ Errors::InvalidOptions ] The error.
+      # @raise [ Errors::InvalidFind ] The error.
       def raise_invalid
         raise Errors::InvalidFind.new
       end

data/lib/mongoid/criteria/queryable/extensions/numeric.rb

@@ -44,7 +44,21 @@ module Mongoid
             #
             # @return [ Object ] The converted number.
             def __numeric__(object)
-              object.to_s.match?(/\A[-+]?[0-9]*[0-9.]0*\z/) ? object.to_i : Float(object)
+              str = object.to_s
+              raise ArgumentError if str.empty?
+
+              # These requirements seem a bit odd, but they're explicitly specified in the tests,
+              # so we're obligated to keep them, for now. (This code was rewritten from a one-line
+              # regex, due to security concerns with a polynomial regex being used on uncontrolled
+              # data).
+
+              str = str.chop if str.end_with?('.')
+              return 0 if str.empty?
+
+              result = Integer(str) rescue Float(object)
+
+              integer = result.to_i
+              integer == result ? integer : result
             end
 
             # Evolve the object to an integer.

data/lib/mongoid/errors/invalid_around_callback.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+    # This error is raised when an around callback is
+    # defined by the user without a yield
+    class InvalidAroundCallback < MongoidError
+      # Create the new error.
+      #
+      # @api private
+      def initialize
+        super(compose_message('invalid_around_callback'))
+      end
+    end
+  end
+end

data/lib/mongoid/errors.rb

@@ -13,6 +13,7 @@ require "mongoid/errors/empty_config_file"
 require "mongoid/errors/immutable_attribute"
 require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_auto_encryption_configuration"
+require "mongoid/errors/invalid_around_callback"
 require "mongoid/errors/invalid_async_query_executor"
 require "mongoid/errors/invalid_collection"
 require "mongoid/errors/invalid_config_file"

data/lib/mongoid/fields.rb

@@ -49,6 +49,11 @@ module Mongoid
     # @api private
     INVALID_BSON_CLASSES = [ BSON::Decimal128, BSON::Int32, BSON::Int64 ].freeze
 
+    # The suffix for generated translated fields.
+    # 
+    # @api private
+    TRANSLATIONS_SFX = '_translations'
+
     module ClassMethods
       # Returns the list of id fields for this model class, as both strings
       # and symbols.
@@ -101,8 +106,8 @@ module Mongoid
           ar.each_with_index do |fn, i|
             key = fn
             unless klass.fields.key?(fn) || klass.relations.key?(fn)
-              if tr = fn.match(/(.*)_translations\z/)&.captures&.first
-                key = tr
+              if fn.end_with?(TRANSLATIONS_SFX)
+                key = fn.delete_suffix(TRANSLATIONS_SFX)
               else
                 key = fn
               end
@@ -408,7 +413,8 @@ module Mongoid
       #
       # @api private
       def database_field_name(name, relations, aliased_fields, aliased_associations)
-        return nil unless name.present?
+        return "" unless name.present?
+
         key = name.to_s
         segment, remaining = key.split('.', 2)
 
@@ -725,11 +731,11 @@ module Mongoid
       # @api private
       def create_translations_getter(name, meth)
         generated_methods.module_eval do
-          re_define_method("#{meth}_translations") do
+          re_define_method("#{meth}#{TRANSLATIONS_SFX}") do
             attributes[name] ||= {}
             attributes[name].with_indifferent_access
           end
-          alias_method :"#{meth}_t", :"#{meth}_translations"
+          alias_method :"#{meth}_t", :"#{meth}#{TRANSLATIONS_SFX}"
         end
       end
 
@@ -745,14 +751,14 @@ module Mongoid
       # @api private
       def create_translations_setter(name, meth, field)
         generated_methods.module_eval do
-          re_define_method("#{meth}_translations=") do |value|
+          re_define_method("#{meth}#{TRANSLATIONS_SFX}=") do |value|
             attribute_will_change!(name)
             value&.transform_values! do |_value|
               field.type.mongoize(_value)
             end
             attributes[name] = value
           end
-          alias_method :"#{meth}_t=", :"#{meth}_translations="
+          alias_method :"#{meth}_t=", :"#{meth}#{TRANSLATIONS_SFX}="
         end
       end
 

data/lib/mongoid/interceptable.rb

@@ -161,11 +161,6 @@ module Mongoid
     # Execute the callbacks of given kind for embedded documents including
     # around callbacks.
     #
-    # @note This method is prone to stack overflow errors if the document
-    #   has a large number of embedded documents. It is recommended to avoid
-    #   using around callbacks for embedded documents until a proper solution
-    #   is implemented.
-    #
     # @param [ Symbol ] kind The type of callback to execute.
     # @param [ Array<Document> ] children Children to execute callbacks on. If
     #  nil, callbacks will be executed on all cascadable children of
@@ -173,17 +168,27 @@ module Mongoid
     #
     #  @api private
     def _mongoid_run_child_callbacks_with_around(kind, children: nil, &block)
-      child, *tail = (children || cascadable_children(kind))
+      children = (children || cascadable_children(kind))
       with_children = !Mongoid::Config.prevent_multiple_calls_of_embedded_callbacks
-      if child.nil?
-        block&.call
-      elsif tail.empty?
-        child.run_callbacks(child_callback_type(kind, child), with_children: with_children, &block)
-      else
-        child.run_callbacks(child_callback_type(kind, child), with_children: with_children) do
-          _mongoid_run_child_callbacks_with_around(kind, children: tail, &block)
+
+      return block&.call if children.empty?
+
+      fibers = children.map do |child|
+        Fiber.new do
+          child.run_callbacks(child_callback_type(kind, child), with_children: with_children) do
+            Fiber.yield
+          end
         end
       end
+
+      fibers.each do |fiber|
+        fiber.resume
+        raise Mongoid::Errors::InvalidAroundCallback unless fiber.alive?
+      end
+
+      block&.call
+
+      fibers.reverse.each(&:resume)
     end
 
     # Execute the callbacks of given kind for embedded documents without

data/lib/mongoid/scopable.rb

@@ -294,7 +294,13 @@ module Mongoid
             scope = instance_exec(*args, **kwargs, &scoping[:scope])
             extension = scoping[:extension]
             to_merge = scope || queryable
-            criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
+
+            criteria = if Mongoid.allow_scopes_to_unset_default_scope
+                         to_merge
+                       else
+                         to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
+                       end
+
             criteria.extend(extension)
             criteria
           end

data/lib/mongoid/touchable.rb

@@ -78,7 +78,7 @@ module Mongoid
         field = database_field_name(field)
 
         write_attribute(:updated_at, now) if respond_to?("updated_at=")
-        write_attribute(field, now) if field
+        write_attribute(field, now) if field.present?
 
         touches = _extract_touches_from_atomic_sets(field) || {}
         touches.merge!(_parent._gather_touch_updates(now) || {}) if _touchable_parent?
@@ -212,12 +212,6 @@ module Mongoid
     #
     # @return [ Symbol ] The method name.
     def define_relation_touch_method(name, association)
-      relation_classes = if association.polymorphic?
-                           association.send(:inverse_association_classes)
-                         else
-                           [ association.relation_class ]
-                         end
-
       method_name = "touch_#{name}_after_create_or_destroy"
       association.inverse_class.class_eval do
         define_method(method_name) do

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # rubocop:todo all
 
 module Mongoid
-  VERSION = "9.0.0"
+  VERSION = "9.0.1"
 end

data/spec/mongoid/association_spec.rb

@@ -15,6 +15,20 @@ describe Mongoid::Association do
     )
   end
 
+  context "when class_name references an unknown class" do
+    context "when loading" do
+      it "does not raise an exception" do
+        expect do
+          class AssocationSpecModel
+            include Mongoid::Document
+
+            embedded_in :parent, class_name: 'SomethingBogusThatDoesNotExistYet'
+          end
+        end.not_to raise_exception
+      end
+    end
+  end
+
   describe "#embedded?" do
 
     let(:person) do

data/spec/mongoid/attributes_spec.rb

@@ -289,6 +289,22 @@ describe Mongoid::Attributes do
         end
       end
 
+      context "when given nil" do
+
+        it "returns nil" do
+         expect(person[nil]).to be nil
+        end
+
+      end
+
+      context "when given an empty string" do
+
+        it "returns nil" do
+         expect(person[""]).to be nil
+        end
+
+      end
+
       context "when the field was not explicitly defined" do
 
         context "when excluding with only and the field was not excluded" do

data/spec/mongoid/contextual/aggregable/memory_spec.rb

@@ -570,5 +570,16 @@ describe Mongoid::Contextual::Aggregable::Memory do
         expect(sum).to eq(1500)
       end
     end
+
+    context "when provided a block with initial value" do
+
+      let(:sum) do
+        context.sum(500, &:likes)
+      end
+
+      it "returns the sum for the provided block starting from initial value" do
+        expect(sum).to eq(2000)
+      end
+    end
   end
 end

data/spec/mongoid/contextual/aggregable/mongo_spec.rb

@@ -515,6 +515,17 @@ describe Mongoid::Contextual::Aggregable::Mongo do
           expect(sum).to eq(1500)
         end
       end
+
+      context "when provided a block with initial value" do
+
+        let(:sum) do
+          context.sum(500, &:likes)
+        end
+
+        it "returns the sum for the provided block starting from initial value" do
+          expect(sum).to eq(2000)
+        end
+      end
     end
   end
 

data/spec/mongoid/contextual/mongo_spec.rb

@@ -3640,6 +3640,75 @@ describe Mongoid::Contextual::Mongo do
               expect(new_order.reload.genres).to eq(["electronic"])
             end
           end
+
+          context "when operation is $pull" do
+            context "when pulling single element" do
+
+              before do
+                depeche_mode.update_attribute(:genres, ["electronic", "pop"])
+                new_order.update_attribute(:genres, ["electronic", "pop"])
+                context.update_all("$pull" => { genres: "electronic" })
+              end
+
+              it "updates the first matching document" do
+                expect(depeche_mode.reload.genres).to eq(["pop"])
+              end
+
+              it "updates the last matching document" do
+                expect(new_order.reload.genres).to eq(["pop"])
+              end
+            end
+
+            context "when pulling based on condition" do
+              before do
+                depeche_mode.update_attribute(:genres, ["electronic", "pop", "dance"])
+                new_order.update_attribute(:genres, ["electronic", "pop", "dance"])
+                context.update_all("$pull" => { genres: { '$in' => ["electronic", "pop"] } })
+              end
+
+              it "updates the first matching document" do
+                expect(depeche_mode.reload.genres).to eq(["dance"])
+              end
+
+              it "updates the last matching document" do
+                expect(new_order.reload.genres).to eq(["dance"])
+              end
+            end
+          end
+
+          context "when operation is $pop" do
+
+            before do
+              depeche_mode.update_attribute(:genres, ["pop", "electronic"])
+            end
+
+            it "removes first element in array" do
+              context.update_all("$pop" => { genres: -1 })
+              expect(depeche_mode.reload.genres).to eq(["electronic"])
+            end
+
+            it "removes last element in array" do
+              context.update_all("$pop" => { genres: 1 })
+              expect(depeche_mode.reload.genres).to eq(["pop"])
+            end
+          end
+
+          context "when operation is $pullAll" do
+
+            before do
+              depeche_mode.update_attribute(:genres, ["pop", "electronic", "dance", "pop" ])
+              new_order.update_attribute(:genres, ["electronic", "pop", "electronic", "dance"])
+              context.update_all("$pullAll" => { genres: ["pop", "electronic"] })
+            end
+
+            it "updates the first matching document" do
+              expect(depeche_mode.reload.genres).to eq(["dance"])
+            end
+
+            it "updates the last matching document" do
+              expect(new_order.reload.genres).to eq(["dance"])
+            end
+          end
         end
 
         context 'when using aliased field names' do
@@ -3659,15 +3728,15 @@ describe Mongoid::Contextual::Mongo do
         context "when the attributes must be mongoized" do
 
           before do
-            context.update_all("$set" => { member_count: "1" })
+            context.update_all("$set" => { location: LatLng.new(52.30, 13.25) })
           end
 
           it "updates the first matching document" do
-            expect(depeche_mode.reload.member_count).to eq(1)
+            expect(depeche_mode.reload.location).to eq(LatLng.new(52.30, 13.25))
           end
 
           it "updates the last matching document" do
-            expect(new_order.reload.member_count).to eq(1)
+            expect(new_order.reload.location).to eq(LatLng.new(52.30, 13.25))
           end
         end
       end

data/spec/mongoid/fields_spec.rb

@@ -1871,12 +1871,12 @@ describe Mongoid::Fields do
 
     context 'given nil' do
       subject { Person.database_field_name(nil) }
-      it { is_expected.to eq nil }
+      it { is_expected.to eq '' }
     end
 
     context 'given an empty String' do
       subject { Person.database_field_name('') }
-      it { is_expected.to eq nil }
+      it { is_expected.to eq '' }
     end
 
     context 'given a String' do