mongoid 7.3.5 → 7.5.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/has_and_belongs_to_many/binding'
 require 'mongoid/association/referenced/has_and_belongs_to_many/buildable'
@@ -11,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The HasAndBelongsToMany type association.
-      #
-      # @since 7.0
       class HasAndBelongsToMany
         include Relatable
         include Buildable
@@ -21,8 +18,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :after_add,
             :after_remove,
@@ -37,35 +32,28 @@ module Mongoid
             :primary_key,
             :inverse_primary_key,
             :inverse_foreign_key,
+            :scope,
         ].freeze
 
         # The complete list of valid options for this association, including
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # The type of the field holding the foreign key.
         #
         # @return [ Array ]
-        #
-        # @since 7.0
         FOREIGN_KEY_FIELD_TYPE = Array
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_ids'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_ids'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ self.class ].freeze
         end
@@ -73,8 +61,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           self
@@ -83,22 +69,16 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def validation_default; true; end
 
         # Are ids only saved on this side of the association?
         #
         # @return [ true, false ] Whether this association has a forced nil inverse.
-        #
-        # @since 7.0
         def forced_nil_inverse?
           @forced_nil_inverse ||= @options.key?(:inverse_of) && !@options[:inverse_of]
         end
@@ -106,15 +86,11 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def stores_foreign_key?; true; end
 
         # Get the association proxy class for this association type.
         #
         # @return [ Association::HasAndBelongsToMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -122,8 +98,6 @@ module Mongoid
         # Get the foreign key field for saving the association reference.
         #
         # @return [ String ] The foreign key field for saving the association reference.
-        #
-        # @since 7.0
         def foreign_key
           @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                              default_foreign_key_field
@@ -132,8 +106,6 @@ module Mongoid
         # The criteria used for querying this association.
         #
         # @return [ Mongoid::Criteria ] The criteria used for querying this association.
-        #
-        # @since 7.0
         def criteria(base, id_list = nil)
           query_criteria(id_list || base.send(foreign_key))
         end
@@ -142,8 +114,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key field for saving the association reference
         #  on the inverse side.
-        #
-        # @since 7.0
         def inverse_foreign_key
           if @options.key?(:inverse_foreign_key)
             @options[:inverse_foreign_key]
@@ -168,8 +138,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key setter for saving the association reference
         #  on the inverse side.
-        #
-        # @since 7.0
         def inverse_foreign_key_setter
           @inverse_foreign_key_setter ||= "#{inverse_foreign_key}=" if inverse_foreign_key
         end
@@ -180,8 +148,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::One ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::Many.new(self, attributes, options)
         end
@@ -194,12 +160,17 @@ module Mongoid
         # @param [ Document ] document The document to calculate on.
         #
         # @return [ Root ] The root atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Root.new(document)
         end
 
+        # Get the scope to be applied when querying the association.
+        #
+        # @return [ Proc | Symbol | nil ] The association scope, if any.
+        def scope
+          @options[:scope]
+        end
+
         private
 
         def setup_instance_methods!
@@ -288,7 +259,9 @@ module Mongoid
         end
 
         def query_criteria(id_list)
-          crit = relation_class.all_of(primary_key => {"$in" => id_list || []})
+          crit = relation_class.criteria
+          crit = crit.apply_scope(scope)
+          crit = crit.all_of(primary_key => {"$in" => id_list || []})
           with_ordering(crit)
         end
       end

data/lib/mongoid/association/referenced/has_many/binding.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -15,8 +14,6 @@ module Mongoid
           #
           # @example Bind one document.
           #   person.posts.bind_one(post)
-          #
-          # @since 2.0.0.rc.1
           def bind_one(doc)
             binding do
               bind_from_relational_parent(doc)
@@ -27,8 +24,6 @@ module Mongoid
           #
           # @example Unbind the document.
           #   person.posts.unbind_one(document)
-          #
-          # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do
               unbind_from_relational_parent(doc)

data/lib/mongoid/association/referenced/has_many/buildable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class HasMany
 
         # The Builder behavior for has_many associations.
-        #
-        # @since 7.0
         module Buildable
 
           # This method either takes an _id or an object and queries for the

data/lib/mongoid/association/referenced/has_many/eager.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association

data/lib/mongoid/association/referenced/has_many/enumerable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -30,15 +29,13 @@ module Mongoid
           # @param [ Enumerable ] other The other enumerable.
           #
           # @return [ true, false ] If the objects are equal.
-          #
-          # @since 2.1.0
           def ==(other)
             return false unless other.respond_to?(:entries)
             entries == other.entries
           end
 
-          # Check equality of the enumerable against the provided object for case
-          # statements.
+          # Check equality of the enumerable against the provided object for
+          # case statements.
           #
           # @example Check case equality.
           #   enumerable === Array
@@ -46,10 +43,13 @@ module Mongoid
           # @param [ Object ] other The object to check.
           #
           # @return [ true, false ] If the objects are equal in a case.
-          #
-          # @since 3.1.4
           def ===(other)
-            other.class == Class ? (Array == other || Enumerable == other) : self == other
+            return false unless other.respond_to?(:entries)
+            if Mongoid.legacy_triple_equals
+              other.class == Class ? (Array == other || Enumerable == other) : self == other
+            else
+              entries === other.entries
+            end
           end
 
           # Append a document to the enumerable.
@@ -60,8 +60,6 @@ module Mongoid
           # @param [ Document ] document The document to append.
           #
           # @return [ Document ] The document.
-          #
-          # @since 2.1.0
           def <<(document)
             _added[document._id] = document
             self
@@ -81,8 +79,6 @@ module Mongoid
           #   end
           #
           # @return [ Array<Document> ] The cleared out _added docs.
-          #
-          # @since 2.1.0
           def clear
             if block_given?
               in_memory { |doc| yield(doc) }
@@ -98,8 +94,6 @@ module Mongoid
           #   enumerable.clone
           #
           # @return [ Array<Document> ] An array clone of the enumerable.
-          #
-          # @since 2.1.6
           def clone
             collect { |doc| doc.clone }
           end
@@ -112,8 +106,6 @@ module Mongoid
           # @param [ Document ] document The document to delete.
           #
           # @return [ Document ] The deleted document.
-          #
-          # @since 2.1.0
           def delete(document)
             doc = (_loaded.delete(document._id) || _added.delete(document._id))
             unless doc
@@ -137,8 +129,6 @@ module Mongoid
           #   end
           #
           # @return [ Array<Document> ] The remaining docs.
-          #
-          # @since 2.1.0
           def delete_if(&block)
             load_all!
             deleted = in_memory.select(&block)
@@ -172,8 +162,6 @@ module Mongoid
           #   a = enumerable.each
           #
           # @return [ true ] That the enumerable is now _loaded.
-          #
-          # @since 2.1.0
           def each
             unless block_given?
               return to_enum
@@ -205,8 +193,6 @@ module Mongoid
           #   enumerable.empty?
           #
           # @return [ true, false ] If the enumerable is empty.
-          #
-          # @since 2.1.0
           def empty?
             if _loaded?
               in_memory.empty?
@@ -257,16 +243,16 @@ module Mongoid
           #   use the option { id_sort: :none }.
           #   Be aware that #first/#last won't guarantee order in this case.
           #
-          # @param [ Hash ] opts The options for the query returning the first document.
+          # @param [ Integer | Hash ] limit_or_opts The number of documents to
+          #   return, or a hash of options.
           #
-          # @option opts [ :none ] :id_sort Don't apply a sort on _id.
+          # @option limit_or_opts [ :none ] :id_sort This option is deprecated.
+          #   Don't apply a sort on _id if no other sort is defined on the criteria.
           #
           # @return [ Document ] The first document found.
-          #
-          # @since 2.1.0
-          def first(opts = {})
+          def first(limit_or_opts = nil)
             _loaded.try(:values).try(:first) ||
-                _added[(ul = _unloaded.try(:first, opts)).try(:_id)] ||
+                _added[(ul = _unloaded.try(:first, limit_or_opts)).try(:_id)] ||
                 ul ||
                 _added.values.try(:first)
           end
@@ -280,8 +266,6 @@ module Mongoid
           #   Enumerable.new([ post ])
           #
           # @param [ Criteria, Array<Document> ] target The wrapped object.
-          #
-          # @since 2.1.0
           def initialize(target, base = nil, association = nil)
             @_base = base
             @_association = association
@@ -304,8 +288,6 @@ module Mongoid
           # @param [ Document ] doc The document to check.
           #
           # @return [ true, false ] If the document is in the target.
-          #
-          # @since 3.0.0
           def include?(doc)
             return super unless _unloaded
             _unloaded.where(_id: doc._id).exists? || _added.has_key?(doc._id)
@@ -318,8 +300,6 @@ module Mongoid
           #   enumerable.inspect
           #
           # @return [ String ] The inspected enum.
-          #
-          # @since 2.1.0
           def inspect
             entries.inspect
           end
@@ -333,8 +313,6 @@ module Mongoid
           #   enumerable.in_memory
           #
           # @return [ Array<Document> ] The in memory docs.
-          #
-          # @since 2.1.0
           def in_memory
             docs = (_loaded.values + _added.values)
             docs.each do |doc|
@@ -354,17 +332,17 @@ module Mongoid
           #   use the option { id_sort: :none }.
           #   Be aware that #first/#last won't guarantee order in this case.
           #
-          # @param [ Hash ] opts The options for the query returning the first document.
+          # @param [ Integer | Hash ] limit_or_opts The number of documents to
+          #   return, or a hash of options.
           #
-          # @option opts [ :none ] :id_sort Don't apply a sort on _id.
+          # @option limit_or_opts [ :none ] :id_sort This option is deprecated.
+          #   Don't apply a sort on _id if no other sort is defined on the criteria.
           #
           # @return [ Document ] The last document found.
-          #
-          # @since 2.1.0
-          def last(opts = {})
+          def last(limit_or_opts = nil)
             _added.values.try(:last) ||
                 _loaded.try(:values).try(:last) ||
-                _added[(ul = _unloaded.try(:last, opts)).try(:_id)] ||
+                _added[(ul = _unloaded.try(:last, limit_or_opts)).try(:_id)] ||
                 ul
           end
 
@@ -374,8 +352,6 @@ module Mongoid
           #   enumerable.load_all!
           #
           # @return [ true ] That the enumerable is _loaded.
-          #
-          # @since 2.1.0
           alias :load_all! :entries
 
           # Has the enumerable been _loaded? This will be true if the criteria has
@@ -385,8 +361,6 @@ module Mongoid
           #   enumerable._loaded?
           #
           # @return [ true, false ] If the enumerable has been _loaded.
-          #
-          # @since 2.1.0
           def _loaded?
             !!@executed
           end
@@ -397,8 +371,6 @@ module Mongoid
           #   Marshal.dump(proxy)
           #
           # @return [ Array<Object> ] The dumped data.
-          #
-          # @since 3.0.15
           def marshal_dump
             [_added, _loaded, _unloaded, @executed]
           end
@@ -409,8 +381,6 @@ module Mongoid
           #   Marshal.load(proxy)
           #
           # @return [ Array<Object> ] The dumped data.
-          #
-          # @since 3.0.15
           def marshal_load(data)
             @_added, @_loaded, @_unloaded, @executed = data
           end
@@ -421,8 +391,6 @@ module Mongoid
           #   enumerable.reset
           #
           # @return [ false ] Always false.
-          #
-          # @since 2.1.0
           def reset
             _loaded.clear
             _added.clear
@@ -436,8 +404,6 @@ module Mongoid
           #   enumerable.reset_unloaded(criteria)
           #
           # @param [ Criteria ] criteria The criteria to replace with.
-          #
-          # @since 3.0.14
           def reset_unloaded(criteria)
             @_unloaded = criteria if _unloaded.is_a?(Criteria)
           end
@@ -452,8 +418,6 @@ module Mongoid
           #   methods.
           #
           # @return [ true, false ] Whether the enumerable responds.
-          #
-          # @since 2.1.0
           def respond_to?(name, include_private = false)
             [].respond_to?(name, include_private) || super
           end
@@ -465,8 +429,6 @@ module Mongoid
           #   enumerable.size
           #
           # @return [ Integer ] The size of the enumerable.
-          #
-          # @since 2.1.0
           def size
             count = (_unloaded ? _unloaded.count : _loaded.count)
             if count.zero?
@@ -486,8 +448,6 @@ module Mongoid
           # @param [ Hash ] options Optional parameters.
           #
           # @return [ String ] The entries all _loaded as a string.
-          #
-          # @since 2.2.0
           def to_json(options = {})
             entries.to_json(options)
           end
@@ -500,8 +460,6 @@ module Mongoid
           # @param [ Hash ] options Optional parameters.
           #
           # @return [ Hash ] The entries all _loaded as a hash.
-          #
-          # @since 2.2.0
           def as_json(options = {})
             entries.as_json(options)
           end
@@ -514,8 +472,6 @@ module Mongoid
           #   enumerable.uniq
           #
           # @return [ Array<Document> ] The unique documents.
-          #
-          # @since 2.1.0
           def uniq
             entries.uniq
           end