jit_preloader 0.2.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2c802d6683cb058781abe0360bec58b0857c020
-  data.tar.gz: 3576db9546592974cc8383c26fa395b939971876
+SHA256:
+  metadata.gz: f6b03d3f3143dc42fbf4b980563021ed9462364d83bbb06d5c41065059c10478
+  data.tar.gz: 8d744ad7498e9ba3b60a01f094abd06db7a35fbbfdf594bba0cf74c9071622fe
 SHA512:
-  metadata.gz: 4cf99a2440af7e4ef861cf2a2ea679f6ff3fac90494aab0fddb5722a1712b9611357d03c15d6cf1a1ced43f698231228c276c517b362fb05937f8e3510a7a8e4
-  data.tar.gz: ba29dd13180a27824ce4e1ad1ec88124c1200e6025a5341a88aff891b706cb1f899a6ba6d59c208c2ae042cc8112df0ea9c4fed90b3e2a7b6d428145b39b5f1b
+  metadata.gz: 33a93b1c222276bce861ca4f441b5f4f9773f6337e39762422defe3fd3a7dedd360626512bb4869cf9b6b1c216035b93caca857093561a7c0378164e8e404085
+  data.tar.gz: c5c34143399f102bf1b20e8f6614cb077debad960b435d42733fbcfd8657a4be7fbec34a8e6883f614e68c1f5a19673d86ce1526f29c124463397fe8fc38aaa6

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

@@ -173,6 +173,43 @@ end
 
 ```
 
+### Preloading a subset of an association
+
+There are often times when you want to preload a subset of an association, or change how the SQL statement is generated. For example, if a `Contact` model has
+an `addresses` association, you may want to be able to get all of the addresses that belong to a specific country without introducing an N+1 query.
+This is a method `preload_scoped_relation` that is available that can handle this for you.
+
+```ruby
+#old
+class Contact < ActiveRecord::Base
+  has_many :addresses
+  has_many :usa_addresses, ->{ where(country: Country.find_by_name("USA")) }
+end
+
+Contact.jit_preload.all.each do |contact|
+  # This will preload the association as expected, but it must be defined as an association in advance
+  contact.usa_addresses
+
+  # This will preload as the entire addresses association, and filters it in memory
+  contact.addresses.select{|address| address.country == Country.find_by_name("USA") }
+
+  # This is an N+1 query
+  contact.addresses.where(country: Country.find_by_name("USA"))
+end
+
+# New
+Contact.jit_preload.all.each do |contact|
+  contact.preload_scoped_relation(
+    name: "USA Addresses",
+    base_association: :addresses,
+    preload_scope: Address.where(country: Country.find_by_name("USA"))
+  )
+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
 
 The JitPreloader can be globally enabled, in which case most N+1 queries in your app should just disappear. It is off by default.
@@ -201,7 +238,7 @@ This is mostly a magic bullet, but it doesn't solve all database-related problem
 ```ruby
 Contact.all.each do |contact|
   contact.emails.reload                         # Reloading the association
-  contact.addresses.where(billing: true).to_a   # Querying the association
+  contact.addresses.where(billing: true).to_a   # Querying the association (Use: preload_scoped_relation to avoid these)
 end
 ```
 

data/jit_preloader.gemspec

@@ -18,13 +18,14 @@ 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"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "db-query-matchers"
 end

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/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/base.rb

@@ -2,6 +2,7 @@ module JitPreloadExtension
   attr_accessor :jit_preloader
   attr_accessor :jit_n_plus_one_tracking
   attr_accessor :jit_preload_aggregates
+  attr_accessor :jit_preload_scoped_relations
 
   def reload(*args)
     clear_jit_preloader!
@@ -10,17 +11,73 @@ module JitPreloadExtension
 
   def clear_jit_preloader!
     self.jit_preload_aggregates = {}
+    self.jit_preload_scoped_relations = {}
     if jit_preloader
       jit_preloader.records.delete(self)
       self.jit_preloader = nil
     end
   end
 
+  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
+
+      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
+      end
+
+      jit_preload_scoped_relations[name]
+    end
+  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={}|
@@ -42,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.3"
+  VERSION = "1.0.1"
 end

data/spec/lib/jit_preloader/active_record/base_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require "db-query-matchers"
+
+RSpec.describe "ActiveRecord::Base Extensions" do
+
+  let(:canada) { Country.create(name: "Canada") }
+  let(:usa) { Country.create(name: "U.S.A") }
+
+  describe "#preload_scoped_relation" do
+    def call(contact)
+      contact.preload_scoped_relation(
+        name: "American Addresses",
+        base_association: :addresses,
+        preload_scope: Address.where(country: usa)
+      )
+    end
+
+    before do
+      Contact.create(name: "Bar", addresses: [
+        Address.new(street: "123 Fake st", country: canada),
+        Address.new(street: "21 Jump st", country: usa),
+        Address.new(street: "90210 Beverly Hills", country: usa)
+      ])
+
+      Contact.create(name: "Foo", addresses: [
+        Address.new(street: "1 First st", country: canada),
+        Address.new(street: "10 Tenth Ave", country: usa)
+      ])
+    end
+
+    context "when operating on a single object" do
+      it "will load the objects for that object" do
+        contact = Contact.first
+        expect(call(contact)).to match_array contact.addresses.where(country: usa).to_a
+      end
+    end
+
+    it "memoizes the result" do
+      contacts = Contact.jit_preload.limit(2).to_a
+
+      expect do
+        expect(call(contacts.first))
+        expect(call(contacts.first))
+      end.to make_database_queries(count: 1)
+    end
+
+    context "when reloading the object" do
+      it "clears the memoization" do
+        contacts = Contact.jit_preload.limit(2).to_a
+
+        expect do
+          expect(call(contacts.first))
+        end.to make_database_queries(count: 1)
+        contacts.first.reload
+        expect do
+          expect(call(contacts.first))
+        end.to make_database_queries(count: 1)
+      end
+    end
+
+    it "will issue one query for the group of objects" do
+      contacts = Contact.jit_preload.limit(2).to_a
+
+      usa_addresses = contacts.first.addresses.where(country: usa).to_a
+      expect do
+        expect(call(contacts.first)).to match_array usa_addresses
+      end.to make_database_queries(count: 1)
+
+      usa_addresses = contacts.last.addresses.where(country: usa).to_a
+      expect do
+        expect(call(contacts.last)).to match_array usa_addresses
+      end.to_not make_database_queries
+    end
+
+    it "doesn't load the value into the association" do
+      contacts = Contact.jit_preload.limit(2).to_a
+      call(contacts.first)
+
+      expect(contacts.first.association(:addresses)).to_not be_loaded
+      expect(contacts.last.association(:addresses)).to_not be_loaded
+    end
+
+    context "when the association is already loaded" do
+      it "doesn't change the value of the association" do
+        contacts = Contact.jit_preload.limit(2).to_a
+        contacts.each{|contact| contact.addresses.to_a }
+        contacts.each{|contact| call(contact) }
+
+        expect(contacts.first.association(:addresses)).to be_loaded
+        expect(contacts.last.association(:addresses)).to be_loaded
+      end
+    end
+  end
+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
 

data/spec/support/models.rb

@@ -12,6 +12,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Kyle d'Oliveira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2021-03-01 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
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: db-query-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The JitPreloader has the ability to send notifications when N+1 queries
   occur to help guage how problematic they are for your code base and a way to remove
   all of the commons explicitly or automatically
@@ -140,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
@@ -155,6 +169,7 @@ files:
 - lib/jit_preloader/active_record/relation.rb
 - lib/jit_preloader/preloader.rb
 - lib/jit_preloader/version.rb
+- spec/lib/jit_preloader/active_record/base_spec.rb
 - spec/lib/jit_preloader/preloader_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
@@ -163,7 +178,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,12 +193,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them
 test_files:
+- spec/lib/jit_preloader/active_record/base_spec.rb
 - spec/lib/jit_preloader/preloader_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb

data/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jit_preloader (0.2.1)
-      activerecord (> 4.2, < 6)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.2)
-      activesupport (= 5.2.2)
-    activerecord (5.2.2)
-      activemodel (= 5.2.2)
-      activesupport (= 5.2.2)
-      arel (>= 9.0)
-    activesupport (5.2.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.4)
-    database_cleaner (1.5.3)
-    diff-lcs (1.2.5)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    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.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  byebug
-  database_cleaner
-  jit_preloader!
-  rake (~> 10.0)
-  rspec
-  sqlite3
-
-BUNDLED WITH
-   2.0.1