jit_preloader 0.2.4 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c697833105982c2f6ee8312618f5d32550c493c00c2b8ca76c6ca1895e387171
-  data.tar.gz: c679aad87494ee39f689ef1e9d071897b78308c3b0c25847009703ec0712e741
+  metadata.gz: 2b1347f4a6e1db52e169d10cb83f6c365867f04882c873c9d6fa11c72553c385
+  data.tar.gz: 90fd4451da01e450c484ff23eec4ac08f9adbc955559adfa57972a639c37fefc
 SHA512:
-  metadata.gz: 6eb1c49ec80fb2b9abf6cba22a38c55043de01e6d9138026b92ce000c460dd2dda20dc72d18ba94cd18b9393dea2cbc2fccfc4806ea6aa93b97bb323a697be9a
-  data.tar.gz: 82b70f1ac6a12c6c87a980f06c1e85802fc5b16f566651c1945ed663d698b11ede6b0b0a4dbc2010b943d18d6955612c78f3281080ef8817e7e7fdc440979ec7
+  metadata.gz: 5fbf30e83a2f31e93831930eb4d4c09d4dc42a75f753f43da8b62082867e8810845f41da09dca4e8e840c2fdae569e1b95d6af565239c55f30b8474c88505cf7
+  data.tar.gz: caf85a19d5a50f325a828fca0c6c3f55adb56345c9fe76afea48abf366706baac3268ec6d6584946516af9f94a3cfc04346f5a886f920d73c8c1a7df6599839a

data/.gitignore

@@ -43,7 +43,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/README.md

@@ -208,6 +208,7 @@ end
 # SELECT * FROM contacts
 # SELECT * FROM countries WHERE name = "USA" LIMIT 1
 # SELECT "addresses".* FROM "addresses" WHERE "addresses"."country_id" = 10 AND "addresses"."contact_id" IN (1, 2, 3, ...)
+```
 
 ### Jit preloading globally across your application
 

data/jit_preloader.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "> 4.2", "< 6"
+  spec.add_dependency "activerecord", "> 5.0", "< 7"
   spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler"

data/lib/jit_preloader.rb

@@ -8,16 +8,17 @@ require 'jit_preloader/active_record/base'
 require 'jit_preloader/active_record/relation'
 require 'jit_preloader/active_record/associations/collection_association'
 require 'jit_preloader/active_record/associations/singular_association'
-if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("5.2.2")
+if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("6.0.0")
+  require 'jit_preloader/active_record/associations/preloader/ar6_association'
+elsif Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("5.2.2")
+  require 'jit_preloader/active_record/associations/preloader/ar5_association'
+else
   require 'jit_preloader/active_record/associations/preloader/collection_association'
   require 'jit_preloader/active_record/associations/preloader/singular_association'
-else
-  require 'jit_preloader/active_record/associations/preloader/association'
 end
 require 'jit_preloader/preloader'
 
 module JitPreloader
-
   def self.globally_enabled=(value)
     @enabled = value
   end

data/lib/jit_preloader/active_record/associations/collection_association.rb

@@ -4,7 +4,7 @@ module JitPreloader
     def load_target
       was_loaded = loaded?
 
-      if !loaded? && owner.persisted? && owner.jit_preloader
+      if !loaded? && owner.persisted? && owner.jit_preloader && (reflection.scope.nil? || reflection.scope.arity == 0)
         owner.jit_preloader.jit_preload(reflection.name)
       end
 

data/lib/jit_preloader/active_record/associations/preloader/{association.rb → ar5_association.rb}

@@ -18,20 +18,13 @@ module JitPreloader
     # end
 
     def run(preloader)
-      all_records = []
-      records = load_records do |record|
-        owner = owners_by_key[convert_key(record[association_key_name])]
-        association = owner.association(reflection.name)
-        association.set_inverse_instance(record)
-      end
+      return unless (reflection.scope.nil? || reflection.scope.arity == 0) && klass.ancestors.include?(ActiveRecord::Base)
 
-      owners.each do |owner|
-        owned_records = records[convert_key(owner[owner_key_name])] || []
-        all_records.concat(Array(owned_records)) if owner.jit_preloader || JitPreloader.globally_enabled?
-        associate_records_to_owner(owner, owned_records)
+      super.tap do
+        if preloaded_records.any? && preloaded_records.none?(&:jit_preloader)
+          JitPreloader::Preloader.attach(preloaded_records) if owners.any?(&:jit_preloader) || JitPreloader.globally_enabled?
+        end
       end
-
-      JitPreloader::Preloader.attach(all_records) if all_records.any?
     end
 
     # Original method:
@@ -54,6 +47,7 @@ module JitPreloader
         # the original copy so that we don't blow away in-memory changes.
         new_records = association.target.any? ? records - association.target : records
         association.target.concat(new_records)
+        association.loaded!
       else
         association.target ||= records.first unless records.empty?
       end
@@ -69,3 +63,4 @@ module JitPreloader
 end
 
 ActiveRecord::Associations::Preloader::Association.prepend(JitPreloader::PreloaderAssociation)
+ActiveRecord::Associations::Preloader::ThroughAssociation.prepend(JitPreloader::PreloaderAssociation)

data/lib/jit_preloader/active_record/associations/preloader/ar6_association.rb

@@ -0,0 +1,57 @@
+module JitPreloader
+  module PreloaderAssociation
+
+    # A monkey patch to ActiveRecord. The old method looked like the snippet
+    # below. Our changes here are that we remove records that are already
+    # part of the target, then attach all of the records to a new jit preloader.
+    #
+    # def run
+    #   records = records_by_owner
+
+    #   owners.each do |owner|
+    #     associate_records_to_owner(owner, records[owner] || [])
+    #   end if @associate
+
+    #   self
+    # end
+
+    def run
+      return unless (reflection.scope.nil? || reflection.scope.arity == 0) && klass.ancestors.include?(ActiveRecord::Base)
+
+      super.tap do
+        if preloaded_records.any? && preloaded_records.none?(&:jit_preloader)
+          JitPreloader::Preloader.attach(preloaded_records) if owners.any?(&:jit_preloader) || JitPreloader.globally_enabled?
+        end
+      end
+    end
+
+    # Original method:
+    # def associate_records_to_owner(owner, records)
+    #   association = owner.association(reflection.name)
+    #   if reflection.collection?
+    #     association.target = records
+    #   else
+    #     association.target = records.first
+    #   end
+    # end
+    def associate_records_to_owner(owner, records)
+      association = owner.association(reflection.name)
+      if reflection.collection?
+        new_records = association.target.any? ? records - association.target : records
+        association.target.concat(new_records)
+        association.loaded!
+      else
+        association.target = records.first
+      end
+    end
+
+    def build_scope
+      super.tap do |scope|
+        scope.jit_preload! if owners.any?(&:jit_preloader) || JitPreloader.globally_enabled?
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::Preloader::Association.prepend(JitPreloader::PreloaderAssociation)
+ActiveRecord::Associations::Preloader::ThroughAssociation.prepend(JitPreloader::PreloaderAssociation)

data/lib/jit_preloader/active_record/associations/singular_association.rb

@@ -4,7 +4,7 @@ module JitPreloader
     def load_target
       was_loaded = loaded?
 
-      if !loaded? && owner.persisted? && owner.jit_preloader
+      if !loaded? && owner.persisted? && owner.jit_preloader && (reflection.scope.nil? || reflection.scope.arity == 0)
         owner.jit_preloader.jit_preload(reflection.name)
       end
 

data/lib/jit_preloader/active_record/base.rb

@@ -18,44 +18,66 @@ module JitPreloadExtension
     end
   end
 
-  def preload_scoped_relation(name:, base_association:, preload_scope: nil)
-    return jit_preload_scoped_relations[name] if jit_preload_scoped_relations&.key?(name)
+  if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("6.0.0")
+    def preload_scoped_relation(name:, base_association:, preload_scope: nil)
+      return jit_preload_scoped_relations[name] if jit_preload_scoped_relations&.key?(name)
+
+      records = jit_preloader&.records || [self]
+
+      preloader_association = ActiveRecord::Associations::Preloader.new.preload(
+        records,
+        base_association,
+        preload_scope
+      ).first
+
+      records.each do |record|
+        record.jit_preload_scoped_relations ||= {}
+        association = record.association(base_association)
+        record.jit_preload_scoped_relations[name] = preloader_association.records_by_owner[record]
+      end
+
+      jit_preload_scoped_relations[name]
+    end
+  else
+    def preload_scoped_relation(name:, base_association:, preload_scope: nil)
+      return jit_preload_scoped_relations[name] if jit_preload_scoped_relations&.key?(name)
+
+      records = jit_preloader&.records || [self]
+      previous_association_values = {}
+
+      records.each do |record|
+        association = record.association(base_association)
+        if association.loaded?
+          previous_association_values[record] = association.target
+          association.reset
+        end
+      end
 
-    records = jit_preloader&.records || [self]
-    previous_association_values = {}
+      ActiveRecord::Associations::Preloader.new.preload(
+        records,
+        base_association,
+        preload_scope
+      )
 
-    records.each do |record|
-      association = record.association(base_association)
-      if association.loaded?
-        previous_association_values[record] = association.target
+      records.each do |record|
+        record.jit_preload_scoped_relations ||= {}
+        association = record.association(base_association)
+        record.jit_preload_scoped_relations[name] = association.target
         association.reset
+        if previous_association_values.key?(record)
+          association.target = previous_association_values[record]
+        end
       end
-    end
 
-    ActiveRecord::Associations::Preloader.new.preload(
-      records,
-      base_association,
-      preload_scope
-    )
-
-    records.each do |record|
-      record.jit_preload_scoped_relations ||= {}
-      association = record.association(base_association)
-      record.jit_preload_scoped_relations[name] = association.target
-      association.reset
-      if previous_association_values.key?(record)
-        association.target = previous_association_values[record]
-      end
+      jit_preload_scoped_relations[name]
     end
-
-    jit_preload_scoped_relations[name]
   end
 
   def self.prepended(base)
     class << base
       delegate :jit_preload, to: :all
 
-      def has_many_aggregate(assoc, name, aggregate, field, default: 0)
+      def has_many_aggregate(assoc, name, aggregate, field, table_alias_name: nil, default: 0)
         method_name = "#{assoc}_#{name}"
 
         define_method(method_name) do |conditions={}|
@@ -77,8 +99,8 @@ module JitPreloadExtension
             association_scope = association_scope.instance_exec(&reflection.scope).reorder(nil) if reflection.scope
 
             # If the query uses an alias for the association, use that instead of the table name
-            table_alias_name = association_scope.references_values.first
-            table_reference = table_alias_name || aggregate_association.table_name
+            table_reference = table_alias_name
+            table_reference ||= association_scope.references_values.first || aggregate_association.table_name
 
             conditions[table_reference] = { aggregate_association.foreign_key => primary_ids }
 

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "0.2.4"
+  VERSION = "1.0.2"
 end

data/spec/lib/jit_preloader/preloader_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe JitPreloader::Preloader do
   let!(:contact1) do
@@ -106,6 +106,19 @@ RSpec.describe JitPreloader::Preloader do
         expect(contact_books.first.children).to include(child1, child2, child3)
       end
     end
+
+    context "when preloading an aggregate for a child model scoped by another join table" do
+      let!(:contact_book) { ContactBook.create(name: "The Yellow Pages") }
+      let!(:contact1) { Company.create(name: "Without Email", contact_book: contact_book) }
+      let!(:contact2) { Company.create(name: "With Blank Email", email_address: EmailAddress.new(address: ""), contact_book: contact_book) }
+      let!(:contact3) { Company.create(name: "With Email", email_address: EmailAddress.new(address: "a@a.com"), contact_book: contact_book) }
+
+      it "can handle queries" do
+        contact_books = ContactBook.jit_preload.to_a
+        expect(contact_books.first.companies_with_blank_email_address_count).to eq 1
+        expect(contact_books.first.companies_with_blank_email_address).to eq [contact2]
+      end
+    end
   end
 
   context "when preloading an aggregate as polymorphic" do
@@ -141,6 +154,16 @@ RSpec.describe JitPreloader::Preloader do
           expect(c.contacts_count).to eql contact_owner_counts[i]
         end
       end
+
+      context "when a record has a polymorphic association type that's not an ActiveRecord" do
+        before do
+          contact1.update!(contact_owner_type: "NilClass", contact_owner_id: nil)
+        end
+
+        it "doesn't die while trying to load the association" do
+          expect(Contact.jit_preload.map(&:contact_owner)).to eq [nil, ContactOwner.first, Address.first]
+        end
+      end
     end
   end
 
@@ -179,6 +202,22 @@ RSpec.describe JitPreloader::Preloader do
     end
   end
 
+  context "when accessing an association with a scope that has a parameter" do
+    let!(:contact_book) { ContactBook.create(name: "The Yellow Pages") }
+    let!(:contact) { Contact.create(name: "Contact", contact_book: contact_book) }
+    let!(:company1) { Company.create(name: "Company1", contact_book: contact_book) }
+
+    it "is unable to be preloaded" do
+      ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+        ContactBook.all.jit_preload.each do |contact_book|
+          expect(contact_book.contacts_with_scope.to_a).to eql [company1, contact]
+        end
+      end
+
+      expect(source_map).to eql(Hash[contact_book, [:contacts_with_scope]])
+    end
+  end
+
   context "when preloading an aggregate on a polymorphic has_many through relationship" do
     let(:contact_owner_addresses_counts) { [3] }
 

data/spec/support/models.rb

@@ -1,5 +1,6 @@
 class ContactBook < ActiveRecord::Base
   has_many :contacts
+  has_many :contacts_with_scope, ->(_contact_book) { desc }, class_name: "Contact", foreign_key: :contact_book_id
   has_many :employees, through: :contacts
 
   has_many :companies
@@ -12,6 +13,9 @@ class ContactBook < ActiveRecord::Base
   has_many_aggregate :employees, :count, :count, "*"
   has_many_aggregate :company_employees, :count, :count, "*"
   has_many_aggregate :children, :count, :count, "*"
+
+  has_many :companies_with_blank_email_address, -> { joins(:email_address).where(email_addresses: { address: "" }) }, class_name: "Company"
+  has_many_aggregate :companies_with_blank_email_address, :count, :count, "*", table_alias_name: "contacts"
 end
 
 class Contact < ActiveRecord::Base
@@ -26,6 +30,8 @@ class Contact < ActiveRecord::Base
   has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)"
   has_many_aggregate :phone_numbers, :count, :count, "id"
   has_many_aggregate :addresses, :count, :count, "*"
+
+  scope :desc, ->{ order(id: :desc) }
 end
 
 class Company < Contact

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.2
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +154,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - jit_preloader.gemspec
 - lib/jit_preloader.rb
 - lib/jit_preloader/active_record/associations/collection_association.rb
-- lib/jit_preloader/active_record/associations/preloader/association.rb
+- lib/jit_preloader/active_record/associations/preloader/ar5_association.rb
+- lib/jit_preloader/active_record/associations/preloader/ar6_association.rb
 - lib/jit_preloader/active_record/associations/preloader/collection_association.rb
 - lib/jit_preloader/active_record/associations/preloader/singular_association.rb
 - lib/jit_preloader/active_record/associations/singular_association.rb
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them

data/Gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jit_preloader (0.2.3)
-      activerecord (> 4.2, < 6)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.4.2)
-      activesupport (= 5.2.4.2)
-    activerecord (5.2.4.2)
-      activemodel (= 5.2.4.2)
-      activesupport (= 5.2.4.2)
-      arel (>= 9.0)
-    activesupport (5.2.4.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    byebug (9.0.6)
-    concurrent-ruby (1.1.6)
-    database_cleaner (1.5.3)
-    db-query-matchers (0.10.0)
-      activesupport (>= 4.0, < 7)
-      rspec (~> 3.0)
-    diff-lcs (1.2.5)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    rake (13.0.1)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    sqlite3 (1.3.12)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  byebug
-  database_cleaner
-  db-query-matchers
-  jit_preloader!
-  rake (~> 13.0)
-  rspec
-  sqlite3
-
-BUNDLED WITH
-   2.0.1