mongoid 9.0.12 → 9.1.0

data/lib/mongoid/association/referenced/has_one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/referenced/has_one/binding'
 require 'mongoid/association/referenced/has_one/buildable'
@@ -9,7 +8,6 @@ require 'mongoid/association/referenced/has_one/eager'
 module Mongoid
   module Association
     module Referenced
-
       # The has_one association.
       class HasOne
         include Relatable
@@ -19,14 +17,14 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        ASSOCIATION_OPTIONS = [
-            :as,
-            :autobuild,
-            :autosave,
-            :dependent,
-            :foreign_key,
-            :primary_key,
-            :scope,
+        ASSOCIATION_OPTIONS = %i[
+          as
+          autobuild
+          autosave
+          dependent
+          foreign_key
+          primary_key
+          scope
         ].freeze
 
         # The complete list of valid options for this association, including
@@ -38,7 +36,7 @@ module Mongoid
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        FOREIGN_KEY_SUFFIX = '_id'.freeze
+        FOREIGN_KEY_SUFFIX = '_id'
 
         # The list of association complements.
         #
@@ -60,19 +58,26 @@ module Mongoid
         # @return [ String ] The foreign key field for saving the
         #   association reference.
         def foreign_key
-          @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
+          @foreign_key ||= if @options[:foreign_key]
+                             @options[:foreign_key].to_s
+                           else
                              default_foreign_key_field
+                           end
         end
 
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        def embedded?; false; end
+        def embedded?
+          false
+        end
 
         # The default for validation the association object.
         #
         # @return [ true ] Always true.
-        def validation_default; true; end
+        def validation_default
+          true
+        end
 
         # Get the association proxy class for this association type.
         #
@@ -120,7 +125,9 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        def stores_foreign_key?; false; end
+        def stores_foreign_key?
+          false
+        end
 
         # Get the path calculator for the supplied document.
         #
@@ -163,19 +170,17 @@ module Mongoid
           @default_foreign_key_field ||= "#{inverse}#{FOREIGN_KEY_SUFFIX}"
         end
 
-        def polymorphic_inverses(other)
+        def polymorphic_inverses(_other)
           [ as ]
         end
 
         def determine_inverses(other)
           matches = (other || relation_class).relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-                rel.relation_class_name == inverse_class_name
-
-          end
-          if matches.size > 1
-            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
+              rel.relation_class_name == inverse_class_name
           end
+          raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches) if matches.size > 1
+
           matches.collect { |m| m.name } unless matches.blank?
         end
 

data/lib/mongoid/association/referenced/syncable.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Referenced
-
       # This module handles the behavior for synchronizing foreign keys between
       # both sides of a many to many associations.
       module Syncable
-
         # Is the document able to be synced on the inverse side? This is only if
         # the key has changed and the association bindings have not been run.
         #
@@ -54,9 +51,9 @@ module Mongoid
         # @return [ Object ] The updated values.
         def remove_inverse_keys(association)
           foreign_keys = send(association.foreign_key)
-          unless foreign_keys.nil? || foreign_keys.empty?
-            association.criteria(self, foreign_keys).pull(association.inverse_foreign_key => _id)
-          end
+          return if foreign_keys.nil? || foreign_keys.empty?
+
+          association.criteria(self, foreign_keys).pull(association.inverse_foreign_key => _id)
         end
 
         # Update the inverse keys for the association.
@@ -68,32 +65,31 @@ module Mongoid
         #
         # @return [ Object ] The updated values.
         def update_inverse_keys(association)
-          if previous_changes.has_key?(association.foreign_key)
-            old, new = previous_changes[association.foreign_key]
-            adds, subs = new - (old || []), (old || []) - new
+          return unless previous_changes.has_key?(association.foreign_key)
 
-            # If we are autosaving we don't want a duplicate to get added - the
-            # $addToSet would run previously and then the $push and $each from the
-            # inverse on the autosave would cause this. We delete each id from
-            # what's in memory in case a mix of id addition and object addition
-            # had occurred.
-            if association.autosave?
-              send(association.name).in_memory.each do |doc|
-                adds.delete_one(doc._id)
-              end
-            end
+          old, new = previous_changes[association.foreign_key]
+          adds, subs = new - (old || []), (old || []) - new
 
-            unless adds.empty?
-              association.criteria(self, adds).without_options.add_to_set(association.inverse_foreign_key => _id)
-            end
-            unless subs.empty?
-              association.criteria(self, subs).without_options.pull(association.inverse_foreign_key => _id)
+          # If we are autosaving we don't want a duplicate to get added - the
+          # $addToSet would run previously and then the $push and $each from the
+          # inverse on the autosave would cause this. We delete each id from
+          # what's in memory in case a mix of id addition and object addition
+          # had occurred.
+          if association.autosave?
+            send(association.name).in_memory.each do |doc|
+              adds.delete_one(doc._id)
             end
           end
+
+          unless adds.empty?
+            association.criteria(self, adds).without_options.add_to_set(association.inverse_foreign_key => _id)
+          end
+          return if subs.empty?
+
+          association.criteria(self, subs).without_options.pull(association.inverse_foreign_key => _id)
         end
 
         module ClassMethods
-
           # Set up the syncing of many to many foreign keys.
           #
           # @example Set up the syncing.
@@ -101,10 +97,10 @@ module Mongoid
           #
           # @param [ Mongoid::Association::Relatable ] association The association metadata.
           def _synced(association)
-            unless association.forced_nil_inverse?
-              synced_save(association)
-              synced_destroy(association)
-            end
+            return if association.forced_nil_inverse?
+
+            synced_save(association)
+            synced_destroy(association)
           end
 
           private
@@ -123,9 +119,9 @@ module Mongoid
           # @return [ Class ] The class getting set up.
           def synced_save(association)
             set_callback(
-                :save,
-                :after,
-                if: ->(doc) { doc._syncable?(association) }
+              :save,
+              :after,
+              if: ->(doc) { doc._syncable?(association) }
             ) do |doc|
               doc.update_inverse_keys(association)
             end
@@ -142,8 +138,8 @@ module Mongoid
           # @return [ Class ] The class getting set up.
           def synced_destroy(association)
             set_callback(
-                :destroy,
-                :after
+              :destroy,
+              :after
             ) do |doc|
               doc.remove_inverse_keys(association)
             end

data/lib/mongoid/association/referenced.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/referenced/auto_save'
 require 'mongoid/association/referenced/counter_cache'

data/lib/mongoid/association/reflections.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
-
     # The reflections module provides convenience methods that can retrieve
     # useful information about associations.
     module Reflections
@@ -34,7 +32,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Returns the association metadata for the supplied name.
         #
         # @example Find association metadata by name.

data/lib/mongoid/association/relatable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
 
 module Mongoid
   module Association
-
     # This module provides behaviors shared between Association types.
     module Relatable
       include Constrainable
@@ -15,17 +13,17 @@ module Mongoid
       # The options shared between all association types.
       #
       # @return [ Array<Symbol> ] The shared options.
-      SHARED_OPTIONS = [
-                         :class_name,
-                         :inverse_of,
-                         :validate,
-                         :extend
-                       ].freeze
+      SHARED_OPTIONS = %i[
+        class_name
+        inverse_of
+        validate
+        extend
+      ].freeze
 
       # The primary key default.
       #
       # @return [ String ] The primary key field default.
-      PRIMARY_KEY_DEFAULT = '_id'.freeze
+      PRIMARY_KEY_DEFAULT = '_id'
 
       # The name of the association.
       #
@@ -37,6 +35,11 @@ module Mongoid
       # @return [ Hash ] The options.
       attr_reader :options
 
+      # The class that owns this association.
+      #
+      # @return [ Class ] The owner class.
+      attr_reader :owner_class
+
       # Initialize the Association.
       #
       # @param [ Class ] _class The class of the model who owns this association.
@@ -62,8 +65,8 @@ module Mongoid
       def ==(other)
         relation_class_name == other.relation_class_name &&
           inverse_class_name == other.inverse_class_name &&
-            name == other.name &&
-              options == other.options
+          name == other.name &&
+          options == other.options
       end
 
       # Get the callbacks for a given type.
@@ -90,7 +93,9 @@ module Mongoid
       # @param [ Document ] doc The document to be bound.
       #
       # @return [ true | false ] Whether the document can be bound.
-      def bindable?(doc); false; end
+      def bindable?(_doc)
+        false
+      end
 
       # Get the inverse names.
       #
@@ -148,7 +153,7 @@ module Mongoid
       def relation_class_name
         @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name)
       end
-      alias :class_name :relation_class_name
+      alias class_name relation_class_name
 
       # The class of the association object(s).
       #
@@ -170,24 +175,7 @@ module Mongoid
           resolve_name(inverse_class, cls_name)
         end
       end
-      alias :klass :relation_class
-
-      # The class of the association target, or nil when the named class is
-      # not defined.
-      #
-      # An association may name a class that never gets defined. The
-      # association is then unusable, but its owner still has to be. Callers
-      # that walk every association of every model, rather than following the
-      # one the application asked for, use this instead of relation_class.
-      #
-      # @return [ Class | nil ] The association objects' class.
-      #
-      # @api private
-      def try_relation_class
-        relation_class
-      rescue NameError
-        nil
-      end
+      alias klass relation_class
 
       # The class name of the object owning this association.
       #
@@ -202,7 +190,7 @@ module Mongoid
       def inverse_class
         @owner_class
       end
-      alias :inverse_klass :inverse_class
+      alias inverse_klass inverse_class
 
       # The foreign key field if this association stores a foreign key.
       # Otherwise, the primary key.
@@ -230,7 +218,7 @@ module Mongoid
       #
       # @return [ String ] The name of the foreign key setter.
       def foreign_key_setter
-        # note: You can't check if this association stores foreign key
+        # NOTE: You can't check if this association stores foreign key
         # See HasOne and HasMany binding, they referenced foreign_key_setter
         @foreign_key_setter ||= "#{foreign_key}=" if foreign_key
       end
@@ -260,7 +248,7 @@ module Mongoid
       #
       # @return [ String ] The foreign key check.
       def foreign_key_check
-        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if (stores_foreign_key? && foreign_key)
+        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if stores_foreign_key? && foreign_key
       end
 
       # Create an association proxy object using the owner and target.
@@ -278,16 +266,19 @@ module Mongoid
       #
       # @return [ true | false ] If the dependent method is destructive.
       def destructive?
-        @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
+        @destructive ||= !!(dependent && %i[delete_all destroy].include?(dependent))
       end
 
       # Get the counter cache column name.
       #
       # @return [ String ] The counter cache column name.
       def counter_cache_column_name
-        @counter_cache_column_name ||= (@options[:counter_cache].is_a?(String) ||
-            @options[:counter_cache].is_a?(Symbol)) ?
-            @options[:counter_cache] : "#{inverse || inverse_class_name.demodulize.underscore.pluralize}_count"
+        @counter_cache_column_name ||= if @options[:counter_cache].is_a?(String) ||
+                                          @options[:counter_cache].is_a?(Symbol)
+                                         @options[:counter_cache]
+                                       else
+                                         "#{inverse || inverse_class_name.demodulize.underscore.pluralize}_count"
+                                       end
       end
 
       # Get the extension.
@@ -320,7 +311,7 @@ module Mongoid
       # The associations above this one in the inclusion tree.
       #
       # @return [ Array<String> ] The associations.
-      attr_accessor :parent_inclusions
+      attr_writer :parent_inclusions
 
       # The associations above this one in the inclusion tree.
       #
@@ -333,14 +324,14 @@ module Mongoid
       #
       # @return [ true | false ] true if it is a *_many association, false if not.
       def many?
-        [Referenced::HasMany, Embedded::EmbedsMany].any? { |a| self.is_a?(a) }
+        [ Referenced::HasMany, Embedded::EmbedsMany ].any? { |a| is_a?(a) }
       end
 
       # Is this association an embeds_one or has_one association?
       #
       # @return [ true | false ] true if it is a *_one association, false if not.
       def one?
-        [Referenced::HasOne, Embedded::EmbedsOne].any? { |a| self.is_a?(a) }
+        [ Referenced::HasOne, Embedded::EmbedsOne ].any? { |a| is_a?(a) }
       end
 
       # Is this association an embedded_in or belongs_to association?
@@ -348,7 +339,7 @@ module Mongoid
       # @return [ true | false ] true if it is an embedded_in or belongs_to
       #   association, false if not.
       def in_to?
-        [Referenced::BelongsTo, Embedded::EmbeddedIn].any? { |a| self.is_a?(a) }
+        [ Referenced::BelongsTo, Embedded::EmbeddedIn ].any? { |a| is_a?(a) }
       end
 
       private
@@ -364,15 +355,15 @@ module Mongoid
       end
 
       def define_touchable!
-        if touchable?
-          Touchable.define_touchable!(self)
-        end
+        return unless touchable?
+
+        Touchable.define_touchable!(self)
       end
 
       def define_autosaver!
-        if autosave?
-          Association::Referenced::AutoSave.define_autosave!(self)
-        end
+        return unless autosave?
+
+        Association::Referenced::AutoSave.define_autosave!(self)
       end
 
       def define_builder!
@@ -404,15 +395,15 @@ module Mongoid
       end
 
       def define_counter_cache_callbacks!
-        if counter_cached?
-          Association::Referenced::CounterCache.define_callbacks!(self)
-        end
+        return unless counter_cached?
+
+        Association::Referenced::CounterCache.define_callbacks!(self)
       end
 
       def define_dependency!
-        if dependent
-          Association::Depending.define_dependency!(self)
-        end
+        return unless dependent
+
+        Association::Depending.define_dependency!(self)
       end
 
       def validate!
@@ -422,27 +413,25 @@ module Mongoid
           end
         end
 
-        [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
-          if Mongoid.destructive_fields.include?(n)
-            raise Errors::InvalidRelation.new(@owner_class, n)
-          end
+        [ name, :"#{name}?", :"#{name}=" ].each do |n|
+          raise Errors::InvalidRelation.new(@owner_class, n) if Mongoid.destructive_fields.include?(n)
         end
       end
 
       def polymorph!
-        if polymorphic?
-          @owner_class.polymorphic = true
-        end
+        return unless polymorphic?
+
+        @owner_class.polymorphic = true
       end
 
       def create_extension!(&block)
-        if block
-          extension_module_name = "#{@owner_class.to_s.demodulize}#{name.to_s.camelize}RelationExtension"
-          silence_warnings do
-            @owner_class.const_set(extension_module_name, Module.new(&block))
-          end
-          @extension = "#{@owner_class}::#{extension_module_name}".constantize
+        return unless block
+
+        extension_module_name = "#{@owner_class.to_s.demodulize}#{name.to_s.camelize}RelationExtension"
+        silence_warnings do
+          @owner_class.const_set(extension_module_name, Module.new(&block))
         end
+        @extension = "#{@owner_class}::#{extension_module_name}".constantize
       end
 
       def default_inverse
@@ -455,7 +444,7 @@ module Mongoid
       # [Foo::Bar, Foo, Object].
       def namespace_hierarchy(mod)
         parent = Object
-        hier = [parent]
+        hier = [ parent ]
 
         # name is not present on anonymous modules
         if mod.name
@@ -480,31 +469,28 @@ module Mongoid
         parts = name.to_s.split('::')
         if parts.first == ''
           parts.shift
-          hierarchy = [Object]
+          hierarchy = [ Object ]
         else
           hierarchy = namespace_hierarchy(mod)
         end
         hierarchy.each do |ns|
-          begin
-            parts.each do |part|
-              # Simple const_get sometimes pulls names out of weird scopes,
-              # perhaps confusing the receiver (ns in this case) with the
-              # local scope. Walk the class hierarchy ourselves one node
-              # at a time by specifying false as the second argument.
-              ns = ns.const_get(part, false)
-            end
-            cls = ns
-            break
-          rescue NameError => e
-            if exc.nil?
-              exc = e
-            end
+          parts.each do |part|
+            # Simple const_get sometimes pulls names out of weird scopes,
+            # perhaps confusing the receiver (ns in this case) with the
+            # local scope. Walk the class hierarchy ourselves one node
+            # at a time by specifying false as the second argument.
+            ns = ns.const_get(part, false)
           end
+          cls = ns
+          break
+        rescue NameError => e
+          exc = e if exc.nil?
         end
         if cls.nil?
           # Raise the first exception, this is from the most specific namespace
           raise exc
         end
+
         cls
       end
     end

data/lib/mongoid/association.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
@@ -19,7 +18,6 @@ require 'mongoid/association/reflections'
 require 'mongoid/association/eager_loadable'
 
 module Mongoid
-
   # Mixin module which adds association behavior to a Mongoid document.
   # Adds methods such as #embedded? which indicate a document's
   # relative association state.
@@ -39,13 +37,13 @@ module Mongoid
     #
     # @return [ Hash ] The mapping from macros to their Association class.
     MACRO_MAPPING = {
-        embeds_one: Association::Embedded::EmbedsOne,
-        embeds_many: Association::Embedded::EmbedsMany,
-        embedded_in: Association::Embedded::EmbeddedIn,
-        has_one: Association::Referenced::HasOne,
-        has_many: Association::Referenced::HasMany,
-        has_and_belongs_to_many: Association::Referenced::HasAndBelongsToMany,
-        belongs_to: Association::Referenced::BelongsTo,
+      embeds_one: Association::Embedded::EmbedsOne,
+      embeds_many: Association::Embedded::EmbedsMany,
+      embedded_in: Association::Embedded::EmbeddedIn,
+      has_one: Association::Referenced::HasOne,
+      has_many: Association::Referenced::HasMany,
+      has_and_belongs_to_many: Association::Referenced::HasAndBelongsToMany,
+      belongs_to: Association::Referenced::BelongsTo
     }.freeze
 
     attr_accessor :_association
@@ -97,6 +95,7 @@ module Mongoid
     # @return [ Symbol ] The association name.
     def association_name
       raise Errors::NoMetadata.new(self.class.name) unless _association
+
       _association.name
     end
 
@@ -128,12 +127,10 @@ module Mongoid
     #
     # @return [ Hash ] The association metadata.
     def reload_relations
-      relations.each_pair do |name, meta|
-        if instance_variable_defined?("@_#{name}")
-          if _parent.nil? || instance_variable_get("@_#{name}") != _parent
-            remove_instance_variable("@_#{name}")
-          end
-        end
+      relations.each_pair do |name, _meta|
+        next unless instance_variable_defined?("@_#{name}")
+
+        remove_instance_variable("@_#{name}") if _parent.nil? || instance_variable_get("@_#{name}") != _parent
       end
     end
   end