mongoid_includes 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4f825eeb6529863b5cc3f92d4c1a633c082b4d3
-  data.tar.gz: fa203f04024bc39551badc6b1980ab08aa9ed91a
+SHA256:
+  metadata.gz: 1fe48fd0ac7d46fb5fe158bac336bfff3a8dde974f10629e3f632fcb3e475e18
+  data.tar.gz: db7fb5e32b06be95c8e133d48e8882249d623528a4bba05220f762b9a436adc2
 SHA512:
-  metadata.gz: cc3ded0ad5fece9fbeff8fd87a36be9abbaeb09cd1e4892b669f3fadeb338bb9634df7a265e958fdc469c132c72bd5cee5c2242fa3a486284f5efdd9dc421b3d
-  data.tar.gz: 1b430caed763a18e25b6c0896e385af0821f1ef8dde44b5dd0d0d7db4c4c138100d7329b87f5a82eb802ee08386273243fe7d5210482a47e49a33f58c9b4a2a4
+  metadata.gz: 0b2e350afb5abc0488ce860052522147cf97f15bd2bbbbda207094e00b2ec0807f281bd44af5f4991eca80139d7d23946a749bf40b3ded0e6ce5d40e870e8243
+  data.tar.gz: e8bd1062e78e5ed04c1a3c9d1377c218f40c06c4d7f85a917c5df90a588516168ac670c01b8f8f86fc8c7addc89bf84c4443248a3f0c3ba0af719a799ed64936

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Mongoid::Includes 3.0.0 (2020-10-29) ##
+
+*  Add support for Mongoid `7.1`.
+*  Avoid making a query when the foreign keys are empty.
+
 ## Mongoid::Includes 2.1.0 (2017-07-03) ##
 
 *   Fix bug where `includes` ignores the `:with` option if the association is polymorphic. Thanks @nickcherry for the bug report!

data/README.md

@@ -3,9 +3,9 @@ Mongoid::Includes
 [![Gem Version](https://badge.fury.io/rb/mongoid_includes.svg)](http://badge.fury.io/rb/mongoid_includes)
 [![Build Status](https://travis-ci.org/ElMassimo/mongoid_includes.svg)](https://travis-ci.org/ElMassimo/mongoid_includes)
 [![Test Coverage](https://codeclimate.com/github/ElMassimo/mongoid_includes/badges/coverage.svg)](https://codeclimate.com/github/ElMassimo/mongoid_includes)
-[![Code Climate](https://codeclimate.com/github/ElMassimo/mongoid_includes.png)](https://codeclimate.com/github/ElMassimo/mongoid_includes)
+[![Code Climate](https://codeclimate.com/github/ElMassimo/mongoid_includes.svg)](https://codeclimate.com/github/ElMassimo/mongoid_includes)
 [![Inline docs](http://inch-ci.org/github/ElMassimo/mongoid_includes.svg)](http://inch-ci.org/github/ElMassimo/mongoid_includes)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/mongoid_includes/blob/master/LICENSE.txt)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/mongoid_includes/blob/main/LICENSE.txt)
 
 `Mongoid::Includes` improves eager loading in Mongoid, supporting polymorphic associations, and nested eager loading.
 

data/lib/mongoid/includes/{relations → association}/eager.rb

@@ -1,6 +1,6 @@
 module Mongoid
   module Includes
-    module Relations
+    module Association
 
       # Internal: Patch to the base class for eager load preload functions,
       # that interacts with the Mongoid::Includes::Inclusion as @medatada.
@@ -9,7 +9,7 @@ module Mongoid
         # Internal: Performs eager load and iterates over the preloaded documents
         # for the current relation.
         def each_loaded_document
-          @metadata.load_documents_for(key, keys_from_docs).each do |doc|
+          @association.load_documents_for(key, keys_from_docs).each do |doc|
             yield doc
           end
         end

data/lib/mongoid/includes/criteria.rb

@@ -19,7 +19,7 @@ module Mongoid
       #               loaded from.
       # from_class: - Necessary to solve ambiguity when doing two-level eager
       #               load through a polymorphic relation.
-      # loader:       - An optional block that specifies how to load all the
+      # with:       - An optional block that specifies how to load all the
       #               related documents.
       #
       # Notes:

data/lib/mongoid/includes/inclusion.rb

@@ -25,7 +25,7 @@ module Mongoid
 
       # Public: Returns true if the relation is a polymorphic belongs_to.
       def polymorphic_belongs_to?
-        metadata.polymorphic? && metadata.relation == Mongoid::Relations::Referenced::In
+        metadata.polymorphic? && metadata.relation == Mongoid::Association::Referenced::BelongsTo::Proxy
       end
 
       # Public: Name of the relation from which a nested inclusion is performed.
@@ -33,11 +33,6 @@ module Mongoid
         @from ||= @options[:from]
       end
 
-      # Internal: Proc that will return the included documents from a set of foreign keys.
-      def loader
-        @loader ||= @options[:loader]
-      end
-
       # Internal: Proc that will modify the documents to include in the relation.
       def modifier
         @modifier ||= @options[:with]
@@ -46,12 +41,11 @@ module Mongoid
       # Public: Preloads the documents for the relation. Uses a custom block
       # if one was provided, or fetches them using the class and the foreign key.
       def load_documents_for(foreign_key, foreign_key_values)
-        if loader
-          loader.call(foreign_key, foreign_key_values)
-        else
-          docs = klass.any_in(foreign_key => foreign_key_values)
-          modifier ? modifier.call(docs) : docs
-        end
+        # NOTE: We assume the upstream code in Mongoid is removing nil keys.
+        return klass.none if foreign_key_values.empty?
+
+        docs = klass.any_in(foreign_key => foreign_key_values)
+        modifier ? modifier.call(docs) : docs
       end
 
       # Public: Clones the inclusion and changes the Mongoid::Metadata::Relation
@@ -60,10 +54,10 @@ module Mongoid
       # Returns an Inclusion that can be eager loaded as usual.
       def for_class_name(class_name)
         Inclusion.new metadata.clone.instance_eval { |relation_metadata|
-          self[:class_name] = @class_name = class_name
-          self[:polymorphic], self[:as], @polymorphic, @klass = nil
+          @options[:class_name] = @class_name = class_name
+          @options[:polymorphic], @options[:as], @polymorphic, @klass = nil
           self
-        }, with: @modifier, loader: @loader
+        }, with: @modifier
       end
     end
   end

data/lib/mongoid/includes/inclusions.rb

@@ -11,15 +11,20 @@ module Mongoid
         super Set.new(object)
       end
 
+      # Override: Avoid replacing existing inclusions.
+      def add(metadata)
+        include?(metadata) ? metadata : super
+      end
+
       # Public: Adds a new relation as an inclusion.
       #
       # Returns the added inclusion.
       def push(metadata, options = {})
         metadata = Inclusion.new(metadata, options) unless metadata.is_a?(Inclusion)
 
-        # Ensure that an inclusion with a specified loader or modifier replaces
-        # a previously specified loader.
-        delete(metadata) if metadata.loader || metadata.modifier
+        # Ensure that an inclusion with a specified modifier replaces a
+        # previously specified one.
+        delete(metadata) if metadata.modifier
 
         # Internally it's a set so it won't add it twice.
         add(metadata)

data/lib/mongoid/includes/version.rb

@@ -5,6 +5,6 @@ module Mongoid
   module Includes
 
     # Public: This library will attempt to follow semantic versioning (whatever that's supposed to be).
-    VERSION = '2.1.0'
+    VERSION = '3.0.1'
   end
 end

data/lib/mongoid/includes.rb

@@ -1,4 +1,4 @@
 require 'mongoid/includes/version'
 require 'mongoid/includes/criteria'
 require 'mongoid/includes/eager_load'
-require 'mongoid/includes/relations/eager'
+require 'mongoid/includes/association/eager'

data/lib/mongoid_includes.rb

@@ -9,4 +9,4 @@ Mongoid::Contextual::Mongo.send :prepend, Mongoid::Includes::EagerLoad
 Mongoid::Contextual::Memory.send :prepend, Mongoid::Includes::EagerLoad
 
 Mongoid::Criteria.send :prepend, Mongoid::Includes::Criteria
-Mongoid::Relations::Eager::Base.send :prepend, Mongoid::Includes::Relations::Eager
+Mongoid::Association::Referenced::Eager::Base.send :prepend, Mongoid::Includes::Association::Eager