mongoid 9.0.12 → 9.1.0

data/lib/mongoid/atomic/modifiers.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
-
     # This class contains the logic for supporting atomic operations against the
     # database.
     class Modifiers < Hash
-
       # Add the atomic $addToSet modifiers to the hash.
       #
       # @example Add the $addToSet modifiers.
@@ -18,10 +15,10 @@ module Mongoid
         modifications.each_pair do |field, value|
           if add_to_sets.has_key?(field)
             value.each do |val|
-              add_to_sets[field]["$each"].push(val)
+              add_to_sets[field]['$each'].push(val)
             end
           else
-            add_to_sets[field] = { "$each" => value }
+            add_to_sets[field] = { '$each' => value }
           end
         end
       end
@@ -35,7 +32,7 @@ module Mongoid
       def pull_all(modifications)
         modifications.each_pair do |field, value|
           add_operation(pull_alls, field, value)
-          pull_fields[field.split(".", 2)[0]] = field
+          pull_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -48,7 +45,7 @@ module Mongoid
       def pull(modifications)
         modifications.each_pair do |field, value|
           pulls[field] = value
-          pull_fields[field.split(".", 2)[0]] = field
+          pull_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -74,10 +71,11 @@ module Mongoid
       # @param [ Hash ] modifications The set modifiers.
       def set(modifications)
         modifications.each_pair do |field, value|
-          next if field == "_id"
+          next if field == '_id'
+
           mods = set_conflict?(field) ? conflicting_sets : sets
           add_operation(mods, field, value)
-          set_fields[field.split(".", 2)[0]] = field
+          set_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -89,7 +87,18 @@ module Mongoid
       # @param [ Array<String> ] modifications The unset association names.
       def unset(modifications)
         modifications.each do |field|
-          unsets.update(field => true)
+          field = field.to_s
+
+          if unset_conflict?(field)
+            # If the conflicting $set covers the entire parent field (not just a
+            # sub-path), it writes the complete current state, which already
+            # reflects this unset. Skip the $unset — it's redundant.
+            next if unset_superseded_by_set?(field)
+
+            conflicting_unsets.update(field => true)
+          else
+            unsets.update(field => true)
+          end
         end
       end
 
@@ -119,7 +128,7 @@ module Mongoid
       end
 
       # Adds or appends an array operation with the $each specifier used
-      # in conjuction with $push.
+      # in conjunction with $push.
       #
       # @example Add the operation.
       #   modifications.add_operation(mods, field, value)
@@ -130,10 +139,10 @@ module Mongoid
       def add_each_operation(mods, field, value)
         if mods.has_key?(field)
           value.each do |val|
-            mods[field]["$each"].push(val)
+            mods[field]['$each'].push(val)
           end
         else
-          mods[field] = { "$each" => value }
+          mods[field] = { '$each' => value }
         end
       end
 
@@ -144,7 +153,7 @@ module Mongoid
       #
       # @return [ Hash ] The $addToSet operations.
       def add_to_sets
-        self["$addToSet"] ||= {}
+        self['$addToSet'] ||= {}
       end
 
       # Is the operation going to be a conflict for a $set?
@@ -156,10 +165,20 @@ module Mongoid
       #
       # @return [ true | false ] If this field is a conflict.
       def set_conflict?(field)
-        name = field.split(".", 2)[0]
+        name = field.split('.', 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
       end
 
+      # Is the operation going to be a conflict for an $unset?
+      #
+      # @param [ String ] field The field.
+      #
+      # @return [ true | false ] If this field is a conflict.
+      def unset_conflict?(field)
+        key = field.split('.', 2)[0]
+        set_fields.has_key?(key)
+      end
+
       # Is the operation going to be a conflict for a $push?
       #
       # @example Is this a conflict for a push?
@@ -169,11 +188,23 @@ module Mongoid
       #
       # @return [ true | false ] If this field is a conflict.
       def push_conflict?(field)
-        name = field.split(".", 2)[0]
+        name = field.split('.', 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||
           (push_fields.keys.count { |item| item.split('.', 2).first == name } > 1)
       end
 
+      # Returns true if the $unset is made redundant by a $set that covers
+      # the entire root-level field. When $set "children" is issued, the
+      # current (live) state of the array already includes all pending changes
+      # (e.g., embedded association removed), so a $unset for any children.*.x
+      # field is unnecessary.
+      #
+      # @param [ String ] field the field
+      def unset_superseded_by_set?(field)
+        key = field.split('.', 2).first
+        sets(initialize: false).has_key?(key)
+      end
+
       # Get the conflicting pull modifications.
       #
       # @example Get the conflicting pulls.
@@ -181,7 +212,7 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting pull operations.
       def conflicting_pulls
-        conflicts["$pullAll"] ||= {}
+        conflicts['$pullAll'] ||= {}
       end
 
       # Get the conflicting push modifications.
@@ -191,7 +222,7 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting push operations.
       def conflicting_pushes
-        conflicts["$push"] ||= {}
+        conflicts['$push'] ||= {}
       end
 
       # Get the conflicting set modifications.
@@ -201,7 +232,14 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting set operations.
       def conflicting_sets
-        conflicts["$set"] ||= {}
+        conflicts['$set'] ||= {}
+      end
+
+      # Get the conflicting unset modifications.
+      #
+      # @return [ Hash ] The conflicting unset operations.
+      def conflicting_unsets
+        conflicts['$unset'] ||= {}
       end
 
       # Get the push operations that would have conflicted with the sets.
@@ -251,7 +289,7 @@ module Mongoid
       #
       # @return [ Hash ] The $pullAll operations.
       def pull_alls
-        self["$pullAll"] ||= {}
+        self['$pullAll'] ||= {}
       end
 
       # Get the $pull operations or initialize a new one.
@@ -261,7 +299,7 @@ module Mongoid
       #
       # @return [ Hash ] The $pull operations.
       def pulls
-        self["$pull"] ||= {}
+        self['$pull'] ||= {}
       end
 
       # Get the $push/$each operations or initialize a new one.
@@ -271,7 +309,7 @@ module Mongoid
       #
       # @return [ Hash ] The $push/$each operations.
       def pushes
-        self["$push"] ||= {}
+        self['$push'] ||= {}
       end
 
       # Get the $set operations or initialize a new one.
@@ -280,8 +318,10 @@ module Mongoid
       #   modifiers.sets
       #
       # @return [ Hash ] The $set operations.
-      def sets
-        self["$set"] ||= {}
+      def sets(initialize: true)
+        return self['$set'] unless initialize
+
+        self['$set'] ||= {}
       end
 
       # Get the $unset operations or initialize a new one.
@@ -291,7 +331,7 @@ module Mongoid
       #
       # @return [ Hash ] The $unset operations.
       def unsets
-        self["$unset"] ||= {}
+        self['$unset'] ||= {}
       end
     end
   end

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
     module Paths
       module Embedded
-
         # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-n.
         class Many
@@ -19,7 +17,7 @@ module Mongoid
           # @param [ Document ] document The document to generate the paths for.
           def initialize(document)
             @document, @parent = document, document._parent
-            @insert_modifier, @delete_modifier ="$push", "$pull"
+            @insert_modifier, @delete_modifier = '$push', '$pull'
           end
 
           # Get the position of the document in the hierarchy. This will
@@ -32,12 +30,11 @@ module Mongoid
           # @return [ String ] The position of the document.
           def position
             pos = parent.atomic_position
-            locator = document.new_record? ? "" : ".#{document._index}"
-            "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
+            locator = document.new_record? ? '' : ".#{document._index}"
+            "#{pos}#{'.' unless pos.blank?}#{document._association.store_as}#{locator}"
           end
 
           class << self
-
             # Get the position of where the document would go for the given
             # association. The use case for this function is when trying to
             # persist an empty list for an embedded association. All of the
@@ -51,7 +48,7 @@ module Mongoid
             # @return [ String ] The position string.
             def position_without_document(parent, association)
               pos = parent.atomic_position
-              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
+              "#{pos}#{'.' unless pos.blank?}#{association.store_as}"
             end
           end
         end

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
     module Paths
       module Embedded
-
         # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-1.
         class One
@@ -19,7 +17,7 @@ module Mongoid
           # @param [ Document ] document The document to generate the paths for.
           def initialize(document)
             @document, @parent = document, document._parent
-            @insert_modifier, @delete_modifier ="$set", "$unset"
+            @insert_modifier, @delete_modifier = '$set', '$unset'
           end
 
           # Get the position of the document in the hierarchy. This will
@@ -32,7 +30,7 @@ module Mongoid
           # @return [ String ] The position of the document.
           def position
             pos = parent.atomic_position
-            "#{pos}#{"." unless pos.blank?}#{document._association.store_as}"
+            "#{pos}#{'.' unless pos.blank?}#{document._association.store_as}"
           end
         end
       end

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

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/atomic/paths/embedded/one"
-require "mongoid/atomic/paths/embedded/many"
+require 'mongoid/atomic/paths/embedded/one'
+require 'mongoid/atomic/paths/embedded/many'
 
 module Mongoid
   module Atomic
     module Paths
-
       # Common functionality between the two different embedded paths.
       module Embedded
-
         attr_reader :delete_modifier, :document, :insert_modifier, :parent
 
         # Get the path to the document in the hierarchy.
@@ -20,7 +17,7 @@ module Mongoid
         #
         # @return [ String ] The path to the document.
         def path
-          @path ||= position.sub(/\.\d+\z/, "")
+          @path ||= position.sub(/\.\d+\z/, '')
         end
       end
     end

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

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
     module Paths
-
       # This class encapsulates behavior for locating and updating root
       # documents atomically.
       class Root
-
         attr_reader :document, :path, :position
 
         # Create the new root path utility.
@@ -18,7 +15,7 @@ module Mongoid
         #
         # @param [ Document ] document The document to generate the paths for.
         def initialize(document)
-          @document, @path, @position = document, "", ""
+          @document, @path, @position = document, '', ''
         end
 
         # Asking for the insert modifier on a document with a root path

data/lib/mongoid/atomic/paths.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/atomic/paths/embedded"
-require "mongoid/atomic/paths/root"
+require 'mongoid/atomic/paths/embedded'
+require 'mongoid/atomic/paths/root'

data/lib/mongoid/atomic.rb

@@ -110,9 +110,6 @@ module Mongoid
     #   exactly. Instead, we assume that two updates conflict if the
     #   first component of the two key paths matches.
     #
-    # @example Get the updates that need to occur.
-    #   person.atomic_updates(children)
-    #
     # @return [ Hash ] The updates and their modifiers.
     #
     # rubocop:disable Style/OptionalBooleanParameter

data/lib/mongoid/attributes/dynamic.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module contains the behavior for dynamic attributes.
     module Dynamic
       extend ActiveSupport::Concern
@@ -88,10 +86,10 @@ module Mongoid
       # @param [ Object ] value The value of the field.
       def process_attribute(name, value)
         responds = respond_to?("#{name}=")
-        if !responds
-          write_attribute(name, value)
-        else
+        if responds
           send("#{name}=", value)
+        else
+          write_attribute(name, value)
         end
       end
 
@@ -102,8 +100,8 @@ module Mongoid
       #
       # @return [ String ] An array of pretty printed dynamic field values.
       def inspect_dynamic_fields
-        keys = attributes.keys - fields.keys - relations.keys - ["_id", self.class.discriminator_key]
-        return keys.map do |name|
+        keys = attributes.keys - fields.keys - relations.keys - [ '_id', self.class.discriminator_key ]
+        keys.map do |name|
           "#{name}: #{attributes[name].inspect}"
         end
       end
@@ -122,6 +120,7 @@ module Mongoid
       def method_missing(name, *args)
         attr = name.to_s
         return super unless attributes.has_key?(attr.reader)
+
         if attr.writer?
           getter = attr.reader
           define_dynamic_writer(getter)

data/lib/mongoid/attributes/nested.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # Defines behavior for the Rails nested attributes feature.
     module Nested
       extend ActiveSupport::Concern
@@ -14,8 +12,7 @@ module Mongoid
       end
 
       module ClassMethods
-
-        REJECT_ALL_BLANK_PROC = ->(attributes){
+        REJECT_ALL_BLANK_PROC = lambda { |attributes|
           attributes.all? { |key, value| key == '_destroy' || value.blank? }
         }
 
@@ -52,16 +49,17 @@ module Mongoid
           options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
           args.each do |name|
             meth = "#{name}_attributes="
-            self.nested_attributes["#{name}_attributes"] = meth
+            nested_attributes["#{name}_attributes"] = meth
             association = relations[name.to_s]
             raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless association
+
             autosave_nested_attributes(association) if options[:autosave]
 
             re_define_method(meth) do |attrs|
               _assigning do
                 if association.polymorphic? and association.inverse_type
                   klass = association.resolver.model_for(send(association.inverse_type))
-                  options = options.merge!(:class_name => klass)
+                  options = options.merge!(class_name: klass)
                 end
                 association.nested_builder(attrs, options).build(self)
               end
@@ -84,10 +82,10 @@ module Mongoid
           # marked as autosave despite the fact that the option isn't present. Because the method
           # Association#autosave? is implemented by checking the autosave option, this is the most
           # straightforward way to mark it.
-          if association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
-            association.options[:autosave] = true
-            Association::Referenced::AutoSave.define_autosave!(association)
-          end
+          return unless association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
+
+          association.options[:autosave] = true
+          Association::Referenced::AutoSave.define_autosave!(association)
         end
       end
     end

data/lib/mongoid/attributes/projector.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module defines projection helpers.
     #
     # Projection rules are rather non-trivial. See
@@ -32,8 +30,7 @@ module Mongoid
         end
       end
 
-      attr_reader :id_projection_value
-      attr_reader :content_projection
+      attr_reader :id_projection_value, :content_projection
 
       # Determine if the specified attribute, or a dot notation path, is allowed
       # by the configured projection, if any.
@@ -48,11 +45,7 @@ module Mongoid
       def attribute_or_path_allowed?(name)
         # Special handling for _id.
         if name == '_id'
-          result = unless id_projection_value.nil?
-            value_inclusionary?(id_projection_value)
-          else
-            true
-          end
+          result = id_projection_value.nil? || value_inclusionary?(id_projection_value)
           return result
         end
 
@@ -65,24 +58,20 @@ module Mongoid
         # Find an item which matches or is a parent of the requested name/path.
         # This handles the case when, for example, the projection was
         # {foo: true} and we want to know if foo.bar is allowed.
-        item, value = content_projection.detect do |path, value|
+        item, value = content_projection.detect do |path, _value|
           (name + '.').start_with?(path + '.')
         end
-        if item
-          return value_inclusionary?(value)
-        end
+        return value_inclusionary?(value) if item
 
         if content_inclusionary?
           # Find an item which would be a strict child of the requested name/path.
           # This handles the case when, for example, the projection was
           # {"foo.bar" => true} and we want to know if foo is allowed.
           # (It is as a container of bars.)
-          item, value = content_projection.detect do |path, value|
+          item, = content_projection.detect do |path, _value|
             (path + '.').start_with?(name + '.')
           end
-          if item
-            return true
-          end
+          return true if item
         end
 
         !content_inclusionary?
@@ -94,9 +83,7 @@ module Mongoid
       #
       # An empty projection is inclusionary.
       def content_inclusionary?
-        if content_projection.empty?
-          return value_inclusionary?(id_projection_value)
-        end
+        return value_inclusionary?(id_projection_value) if content_projection.empty?
 
         value_inclusionary?(content_projection.values.first)
       end

data/lib/mongoid/attributes/readonly.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module defines behavior for readonly attributes.
     module Readonly
       extend ActiveSupport::Concern
@@ -30,11 +28,9 @@ module Mongoid
 
       def as_writable_attribute!(name, value = :nil)
         normalized_name = database_field_name(name)
-        if attribute_writable?(normalized_name)
-          yield(normalized_name)
-        else
-          raise Errors::ReadonlyAttribute.new(name, value)
-        end
+        raise Errors::ReadonlyAttribute.new(name, value) unless attribute_writable?(normalized_name)
+
+        yield(normalized_name)
       end
 
       def _loaded?(name)
@@ -47,7 +43,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Defines an attribute as readonly. This will ensure that the value for
         # the attribute is only set when the document is new or we are
         # creating. In other cases, the field write will be ignored with the
@@ -68,12 +63,12 @@ module Mongoid
         # parent's readonly attributes at the time of its creation.
         # Updating the parent does not propagate down to child classes after wards.
         def attr_readonly(*names)
-          self.readonly_attributes = self.readonly_attributes.dup
+          self.readonly_attributes = readonly_attributes.dup
           names.each do |name|
-            self.readonly_attributes << database_field_name(name)
+            readonly_attributes << database_field_name(name)
           end
         end
       end
     end
   end
-end
+end