jit_preloader 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2c802d6683cb058781abe0360bec58b0857c020
-  data.tar.gz: 3576db9546592974cc8383c26fa395b939971876
+SHA256:
+  metadata.gz: c697833105982c2f6ee8312618f5d32550c493c00c2b8ca76c6ca1895e387171
+  data.tar.gz: c679aad87494ee39f689ef1e9d071897b78308c3b0c25847009703ec0712e741
 SHA512:
-  metadata.gz: 4cf99a2440af7e4ef861cf2a2ea679f6ff3fac90494aab0fddb5722a1712b9611357d03c15d6cf1a1ced43f698231228c276c517b362fb05937f8e3510a7a8e4
-  data.tar.gz: ba29dd13180a27824ce4e1ad1ec88124c1200e6025a5341a88aff891b706cb1f899a6ba6d59c208c2ae042cc8112df0ea9c4fed90b3e2a7b6d428145b39b5f1b
+  metadata.gz: 6eb1c49ec80fb2b9abf6cba22a38c55043de01e6d9138026b92ce000c460dd2dda20dc72d18ba94cd18b9393dea2cbc2fccfc4806ea6aa93b97bb323a697be9a
+  data.tar.gz: 82b70f1ac6a12c6c87a980f06c1e85802fc5b16f566651c1945ed663d698b11ede6b0b0a4dbc2010b943d18d6955612c78f3281080ef8817e7e7fdc440979ec7

data/Gemfile.lock

@@ -1,33 +1,36 @@
 PATH
   remote: .
   specs:
-    jit_preloader (0.2.1)
+    jit_preloader (0.2.3)
       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)
+    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.2)
+    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.4)
+    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.6.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
+    minitest (5.14.0)
+    rake (13.0.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -43,7 +46,7 @@ GEM
     rspec-support (3.5.0)
     sqlite3 (1.3.12)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -53,8 +56,9 @@ DEPENDENCIES
   bundler
   byebug
   database_cleaner
+  db-query-matchers
   jit_preloader!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec
   sqlite3
 

data/README.md

@@ -173,6 +173,42 @@ 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 +237,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

@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   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/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,12 +11,46 @@ 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
 
+  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
+
   def self.prepended(base)
     class << base
       delegate :jit_preload, to: :all

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -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
@@ -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
@@ -178,12 +193,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.6
 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