mongoid_includes 1.1.3 → 3.0.0

data/spec/mongoid/includes/inclusions_spec.rb

@@ -20,11 +20,9 @@ describe Mongoid::Includes::Inclusions do
       And  { result.class == Mongoid::Includes::Inclusions }
     end
 
-    context 'prevents duplicates' do
-      Given {
-        inclusions.add(Band.relations['albums'])
-      }
-      Then { inclusions.size == 3 }
+    it 'prevents duplicates' do
+      new_criteria = criteria.includes(:albums)
+      expect(new_criteria.inclusions.size).to eq 3
     end
   end
 end

data/spec/mongoid/includes/polymorphic_includes_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Mongoid::Includes::Criteria do
+
+  describe '#includes' do
+    Given(:inclusions) { criteria.inclusions }
+
+    context 'multiple inclusions through polymorphic associations' do
+      Given(:pink_floyd) { Band.create!(name: 'Pink Floyd', musician_ids: [nil, '']) }
+      Given(:jethro) { Band.create!(name: 'Jethro Tull') }
+      Given {
+        Artist.create!(name: 'David Gilmour', associated_act: pink_floyd)
+        wywh = Album.create!(name: 'Wish You Were Here', release: Date.new(1975), owner: pink_floyd)
+        Album.create!(name: 'The Dark Side of the Moon', release: Date.new(1973), owner: pink_floyd)
+
+        Artist.create!(name: 'Ian Anderson', associated_act: jethro)
+        standup = Album.create!(name: 'Stand Up', release: Date.new(1969), owner: jethro)
+        Album.create!(name: 'Aqualung', release: Date.new(1971), owner: jethro)
+
+        Song.create!(name: 'Shine On', album: wywh)
+        Song.create!(name: 'We Used to Know', album: standup)
+      }
+      Given(:criteria) {
+        Artist
+          .includes(:musicians, from: :associated_act, from_class: Band)
+          .includes(:associated_act, with: ->(bands) {
+            bands
+              .includes(:albums, with: ->(albums) { albums.gt(release: 1970) })
+              .includes(:songs, from: :albums, with: ->(songs) { songs })
+          })
+      }
+
+      describe ':with inclusions should not be overriden' do
+        When(:artists) { expect_query(4) { criteria.entries } } # There are no musicians, so no query should be made.
+        Given(:albums) { artists.map(&:associated_act).flat_map(&:albums) }
+        Then { artists.size == 2 }
+        And {
+          expect_no_queries { albums.size == 3 } # gt(release: 1970)
+        }
+        And {
+          expect_no_queries { albums.flat_map(&:songs).size == 1 } # Only "Shine On"
+        }
+      end
+
+      describe 'should not replace an includes with an specified modifier with a generic one' do
+        Given(:inclusions) { new_criteria.inclusions.to_a }
+        When(:new_criteria) { criteria.includes(:musicians, from: :associated_act, from_class: Band) }
+        Then { inclusions.size == 2 }
+        And  { inclusions.first.nested? }
+        And  { inclusions.last.polymorphic? && inclusions.last.modifier }
+      end
+
+      it 'should fail if a polymorphic association is not disambiguated' do
+        expect {
+          criteria.includes(:musicians, from: :associated_act)
+        }.to raise_error(Mongoid::Includes::Errors::InvalidPolymorphicIncludes)
+      end
+    end
+  end
+end

data/spec/mongoid/includes/simple_inclusions_spec.rb

@@ -306,13 +306,6 @@ describe Mongoid::Includes::Criteria do
             end
           end
 
-          it 'does not eager load the first document' do
-            doc = criteria.first
-            expect_query(1) do
-              expect(doc.person).to eq(person)
-            end
-          end
-
           it 'returns the last document' do
             expect(document).to eq(post_two)
           end
@@ -334,7 +327,7 @@ describe Mongoid::Includes::Criteria do
         end
 
         let!(:depeche) do
-          Band.create!(name: 'Depeche Mode')
+          Band.create!(name: 'Depeche Mode', records: [Record.new(name: 'Music for the Masses')])
         end
 
         let!(:tool) do
@@ -354,10 +347,6 @@ describe Mongoid::Includes::Criteria do
             peep.reload.addresses.includes(:band)
           end
 
-          let(:context) do
-            criteria.context
-          end
-
           let!(:document) do
             criteria.first
           end
@@ -368,13 +357,6 @@ describe Mongoid::Includes::Criteria do
             end
           end
 
-          it 'does not eager load the last document' do
-            doc = criteria.last
-            expect_query(1) do
-              expect(doc.band).to eq(tool)
-            end
-          end
-
           it 'returns the document' do
             expect(document).to eq(address_one)
           end
@@ -386,10 +368,6 @@ describe Mongoid::Includes::Criteria do
             peep.reload.addresses.includes(:band)
           end
 
-          let(:context) do
-            criteria.context
-          end
-
           let!(:document) do
             criteria.last
           end
@@ -400,13 +378,6 @@ describe Mongoid::Includes::Criteria do
             end
           end
 
-          it 'does not eager load the first document' do
-            doc = criteria.first
-            expect_query(1) do
-              expect(doc.band).to eq(depeche)
-            end
-          end
-
           it 'returns the document' do
             expect(document).to eq(address_two)
           end
@@ -418,10 +389,6 @@ describe Mongoid::Includes::Criteria do
             peep.reload.addresses.includes(:band)
           end
 
-          let(:context) do
-            criteria.context
-          end
-
           let!(:documents) do
             criteria.to_a
           end
@@ -500,7 +467,7 @@ describe Mongoid::Includes::Criteria do
           end
 
           before do
-            expect(new_context).to receive(:eager_load_one).with(person).once.and_call_original
+            expect(new_context).to receive(:eager_load).with([person]).once.and_call_original
           end
 
           let!(:from_db) do
@@ -551,7 +518,7 @@ describe Mongoid::Includes::Criteria do
         end
 
         before do
-          expect(context).to receive(:eager_load_one).with(person).once.and_call_original
+          expect(context).to receive(:eager_load).with([person]).once.and_call_original
         end
 
         let!(:from_db) do
@@ -914,7 +881,7 @@ describe Mongoid::Includes::Criteria do
         end
 
         before do
-          expect(context).to receive(:eager_load).with([ game_one, game_two ]).once.and_call_original
+          expect(context).to receive(:preload).twice.and_call_original
         end
 
         let!(:documents) do
@@ -977,7 +944,7 @@ describe Mongoid::Includes::Criteria do
       end
 
       before do
-        expect(context).to receive(:eager_load).with([ person ]).once.and_call_original
+        expect(context).to receive(:preload).twice.and_call_original
       end
 
       let!(:documents) do

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-end
+require 'simplecov'
+SimpleCov.start
 
 require 'rspec/given'
 require 'pry'
@@ -45,8 +43,11 @@ Mongoid.configure do |config|
   )
 end
 
-if defined?(Mongo)
-  Mongo::Logger.logger = Logger.new("./spec/mongo.log")
+# Logging to the console is useful for debugging queries.
+Mongo::Logger.logger = Logger.new('./spec/mongo.log')
+
+def log_mongo_to_console
+  Mongo::Logger.logger = Logger.new($stdout)
 end
 
 RSpec.configure do |config|

data/spec/support/helpers.rb

@@ -1,43 +1,20 @@
 module Mongoid
-  class QueryCounter
-    attr_reader :events
-
-    def initialize
-      @events = []
-    end
-
-    def instrument
-      subscriber = ActiveSupport::Notifications.subscribe('query.moped') do |*args|
-        @events << ActiveSupport::Notifications::Event.new(*args)
-      end
-      yield
-    ensure
-      ActiveSupport::Notifications.unsubscribe(subscriber)
-    end
-
-    def inspect
-      @events.map { |e| e.payload[:ops].map(&:log_inspect) }.join("\n")
+  module SpecHelpers
+    def connection_class
+      Mongo::Server::ConnectionBase
     end
-  end
-end
 
-module Mongoid
-  module SpecHelpers
-    if defined?(Mongo::Logger.logger)
-      def expect_query(number)
-        # There are both start and complete events for each query.
-        expect(Mongo::Logger.logger).to receive(:debug?).exactly(number * 4).times.and_call_original
-        yield
-      end
-    else
-      def expect_query(number, &block)
-        query_counter = Mongoid::QueryCounter.new
-        query_counter.instrument(&block)
-        expect(query_counter.events.size).to(eq(number), %[
-  Expected to receive #{number} queries, it received #{query_counter.events.size}
-  #{query_counter.inspect}
-  ])
+    def expect_query(number)
+      rv = nil
+      RSpec::Mocks.with_temporary_scope do
+        if number > 0
+          expect_any_instance_of(connection_class).to receive(:command_started).exactly(number).times.and_call_original
+        else
+          expect_any_instance_of(connection_class).not_to receive(:command_started)
+        end
+        rv = yield
       end
+      rv
     end
 
     def expect_no_queries(&block)

data/spec/support/models/address.rb

@@ -26,44 +26,8 @@ class Address
 
   belongs_to :band
 
-  embedded_in :addressable, polymorphic: true do
-    def extension
-      "Testing"
-    end
-    def doctor?
-      title == "Dr"
-    end
-  end
-
-  scope :without_postcode, ->{ where(postcode: nil) }
-  scope :rodeo, ->{ where(street: "Rodeo Dr") } do
-    def mansion?
-      all? { |address| address.street == "Rodeo Dr" }
-    end
-  end
+  embedded_in :addressable, polymorphic: true
 
   validates_presence_of :street, on: :update
   validates_format_of :street, with: /\D/, allow_nil: true
-
-  def set_parent=(set = false)
-    self.parent_title = addressable.title if set
-  end
-
-  def <=>(other)
-    street <=> other.street
-  end
-
-  class << self
-    def california
-      where(state: "CA")
-    end
-
-    def homes
-      where(address_type: "Home")
-    end
-
-    def streets
-      all.map(&:street)
-    end
-  end
 end

data/spec/support/models/artist.rb

@@ -5,4 +5,6 @@ class Artist
 
   has_many :albums
   has_one :musician
+
+  belongs_to :associated_act, polymorphic: true
 end

data/spec/support/models/game.rb

@@ -7,11 +7,7 @@ class Game
 
   belongs_to :person, index: true, validate: true
 
-  if Mongoid::VERSION >= "6.0.0"
-    belongs_to :parent, class_name: "Game", foreign_key: "parent-id", optional: true
-  else
-    belongs_to :parent, class_name: "Game", foreign_key: "parent-id"
-  end
+  belongs_to :parent, class_name: "Game", foreign_key: "parent-id", optional: true
 
   accepts_nested_attributes_for :person
 

data/spec/support/models/musician.rb

@@ -3,8 +3,4 @@ require './spec/support/models/person'
 class Musician < Person
 
   has_and_belongs_to_many :bands
-
-  def musician?
-    true
-  end
 end

data/spec/support/models/person.rb

@@ -47,26 +47,11 @@ class Person
 
   attr_reader :rescored
 
-  embeds_many :addresses, as: :addressable, validate: false do
-    def extension
-      "Testing"
-    end
-    def find_by_street(street)
-      where(street: street).first
-    end
-  end
+  embeds_many :addresses, as: :addressable, validate: false
 
-  has_one :game, dependent: :destroy, validate: false do
-    def extension
-      "Testing"
-    end
-  end
+  has_one :game, dependent: :destroy, validate: false
 
-  has_many :posts, dependent: :delete, validate: false do
-    def extension
-      "Testing"
-    end
-  end
+  has_many :posts, dependent: :delete_all, validate: false
 
   has_and_belongs_to_many :preferences, index: true, dependent: :nullify, validate: false
 end

data/spec/support/models/post.rb

@@ -1,3 +1,5 @@
+require_relative './person'
+
 class Post
   include Mongoid::Document
   include Mongoid::Attributes::Dynamic

data/spec/support/models/record.rb

@@ -3,48 +3,5 @@ class Record
 
   field :name, type: String
 
-  field :before_create_called, type: Mongoid::Boolean, default: false
-  field :before_save_called, type: Mongoid::Boolean, default: false
-  field :before_update_called, type: Mongoid::Boolean, default: false
-  field :before_validation_called, type: Mongoid::Boolean, default: false
-  field :before_destroy_called, type: Mongoid::Boolean, default: false
-
   embedded_in :band
-
-  before_create :before_create_stub
-  before_save :before_save_stub
-  before_update :before_update_stub
-  before_validation :before_validation_stub
-  before_destroy :before_destroy_stub
-
-  after_destroy :access_band
-
-  def before_create_stub
-    self.before_create_called = true
-  end
-
-  def before_save_stub
-    self.before_save_called = true
-  end
-
-  def before_update_stub
-    self.before_update_called = true
-  end
-
-  def before_validation_stub
-    self.before_validation_called = true
-  end
-
-  def before_destroy_stub
-    self.before_destroy_called = true
-  end
-
-  def access_band
-    band.name
-  end
-
-  def dont_call_me_twice
-  end
-
-  validate { dont_call_me_twice }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_includes
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Máximo Mussini
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 7.0.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 7.0.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
 description: Mongoid::Includes improves eager loading in Mongoid, supporting polymorphic
   associations, and up to two-levels of eager loading.
 email:
@@ -44,6 +44,7 @@ files:
 - Rakefile
 - lib/config/locales/en.yml
 - lib/mongoid/includes.rb
+- lib/mongoid/includes/association/eager.rb
 - lib/mongoid/includes/criteria.rb
 - lib/mongoid/includes/eager_load.rb
 - lib/mongoid/includes/errors.rb
@@ -51,7 +52,6 @@ files:
 - lib/mongoid/includes/errors/invalid_polymorphic_includes.rb
 - lib/mongoid/includes/inclusion.rb
 - lib/mongoid/includes/inclusions.rb
-- lib/mongoid/includes/relations/eager.rb
 - lib/mongoid/includes/version.rb
 - lib/mongoid_includes.rb
 - spec/mongo.log
@@ -60,6 +60,7 @@ files:
 - spec/mongoid/includes/errors/invalid_polymorphic_includes_spec.rb
 - spec/mongoid/includes/inclusions_spec.rb
 - spec/mongoid/includes/nested_inclusions_spec.rb
+- spec/mongoid/includes/polymorphic_includes_spec.rb
 - spec/mongoid/includes/simple_inclusions_spec.rb
 - spec/spec_helper.rb
 - spec/support/config/mongoid.yml
@@ -80,7 +81,7 @@ homepage: https://github.com/ElMassimo/mongoid_includes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -96,32 +97,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Improved eager loading support for Mongoid.
 test_files:
-- spec/mongo.log
-- spec/mongoid/includes/criteria_spec.rb
-- spec/mongoid/includes/errors/invalid_includes_spec.rb
-- spec/mongoid/includes/errors/invalid_polymorphic_includes_spec.rb
 - spec/mongoid/includes/inclusions_spec.rb
-- spec/mongoid/includes/nested_inclusions_spec.rb
+- spec/mongoid/includes/polymorphic_includes_spec.rb
 - spec/mongoid/includes/simple_inclusions_spec.rb
+- spec/mongoid/includes/nested_inclusions_spec.rb
+- spec/mongoid/includes/criteria_spec.rb
+- spec/mongoid/includes/errors/invalid_polymorphic_includes_spec.rb
+- spec/mongoid/includes/errors/invalid_includes_spec.rb
 - spec/spec_helper.rb
-- spec/support/config/mongoid.yml
 - spec/support/helpers.rb
-- spec/support/models/address.rb
+- spec/support/config/mongoid.yml
+- spec/support/models/song.rb
+- spec/support/models/node.rb
+- spec/support/models/musician.rb
+- spec/support/models/record.rb
 - spec/support/models/album.rb
 - spec/support/models/artist.rb
-- spec/support/models/band.rb
 - spec/support/models/game.rb
-- spec/support/models/musician.rb
-- spec/support/models/node.rb
 - spec/support/models/person.rb
+- spec/support/models/band.rb
 - spec/support/models/post.rb
+- spec/support/models/address.rb
 - spec/support/models/preference.rb
-- spec/support/models/record.rb
-- spec/support/models/song.rb
-has_rdoc: 
+- spec/mongo.log