jit_preloader 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3ebb3488bb221f516f32ebd2fbbedcee866b57d3ccc3c171f3843b9cc0af45
-  data.tar.gz: 7bcaa0e57a6ee5541ca0fac7013f4188113f3425675df4ad29cab7cba3c8a540
+  metadata.gz: 515aa37a3edcd60ff85c7490bf7a96906a612c7b5645d3d81542c5e7997a9026
+  data.tar.gz: 4cab1990cd0346da95d0d0785d28b18d5db95fecf66dbfcf14be26d0b020af5d
 SHA512:
-  metadata.gz: 7d696d0f3465be1aa319ae86c335e087b967847fefcd49a926e27c1cc24681be824ecc2a95a6365a129ae668f2abb341d570841f242cbb4b47295f974a3bf71e
-  data.tar.gz: 5ac6f866cc9ee0fbab43e36d8bd2134e42782e6a6e9e4e635bd9b15e5951a02ed2d1d86b003afdbf5aeac736ffd3a23aadc7e9f75db1679cfd0768e132e2d5b4
+  metadata.gz: bf81adb00759b36e3bea5dfcaf9431c3259cac06412b57008e799585c7094d97073f836300a9631bd24fa0de7820874646861e7ea68e27cb773662d2e3826dec
+  data.tar.gz: b96b45f91474ca01a5235d5ba071c750268e7c029fcfa371c308747433a5cb9f54bfb2560a99051c335352c8a536a01887ae01bb840337ee2e9ab3a808f5ec84

data/.github/workflows/CODEOWNERS

@@ -0,0 +1,3 @@
+# Own any files in the .github/workflows directory and any of its
+# subdirectories.
+/.github/workflows/ @clio/application-security @clio/penguins

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  workflow_dispatch:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
+    - name: Publish to RubyGems
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem

data/Gemfile.5.2

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~>5.2"
+
+# Specify your gem's dependencies in jit_preloader.gemspec
+gemspec

data/Gemfile.5.2.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    jit_preloader (1.0.3)
+      activerecord (>= 5.2, < 7)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.6)
+      activesupport (= 5.2.6)
+    activerecord (5.2.6)
+      activemodel (= 5.2.6)
+      activesupport (= 5.2.6)
+      arel (>= 9.0)
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    db-query-matchers (0.10.0)
+      activesupport (>= 4.0, < 7)
+      rspec (~> 3.0)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  bundler
+  byebug
+  database_cleaner
+  db-query-matchers
+  jit_preloader!
+  rake (~> 13.0)
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   2.2.12

data/Gemfile.6.0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~>6.0.0"
+
+# Specify your gem's dependencies in jit_preloader.gemspec
+gemspec

data/Gemfile.6.0.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    jit_preloader (1.0.3)
+      activerecord (>= 5.2, < 7)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activerecord (6.0.4.1)
+      activemodel (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activesupport (6.0.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    db-query-matchers (0.10.0)
+      activesupport (>= 4.0, < 7)
+      rspec (~> 3.0)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  activerecord (~> 6.0.0)
+  bundler
+  byebug
+  database_cleaner
+  db-query-matchers
+  jit_preloader!
+  rake (~> 13.0)
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   2.2.12

data/Gemfile.6.1

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~>6.1"
+
+# Specify your gem's dependencies in jit_preloader.gemspec
+gemspec

data/Gemfile.6.1.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    jit_preloader (1.0.3)
+      activerecord (>= 5.2, < 7)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    db-query-matchers (0.10.0)
+      activesupport (>= 4.0, < 7)
+      rspec (~> 3.0)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  activerecord (~> 6.1)
+  bundler
+  byebug
+  database_cleaner
+  db-query-matchers
+  jit_preloader!
+  rake (~> 13.0)
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   2.2.12

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", "> 5.0", "< 7"
+  spec.add_dependency "activerecord", ">= 5.2", "< 7"
   spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler"

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

@@ -18,6 +18,8 @@ module JitPreloader
     # end
 
     def run(preloader)
+      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?
@@ -47,7 +49,7 @@ module JitPreloader
         association.target.concat(new_records)
         association.loaded!
       else
-        association.target ||= records.first unless records.empty?
+        association.target = records.first unless records.empty?
       end
     end
 

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

@@ -16,6 +16,8 @@ module JitPreloader
     # 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?

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

@@ -23,6 +23,15 @@ module JitPreloadExtension
       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
 
       preloader_association = ActiveRecord::Associations::Preloader.new.preload(
         records,
@@ -33,7 +42,11 @@ module JitPreloadExtension
       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]
+        record.jit_preload_scoped_relations[name] = preloader_association.records_by_owner[record] || []
+        association.reset
+        if previous_association_values.key?(record)
+          association.target = previous_association_values[record]
+        end
       end
 
       jit_preload_scoped_relations[name]

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "1.0.0"
+  VERSION = "1.0.4"
 end

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

@@ -74,6 +74,9 @@ RSpec.describe "ActiveRecord::Base Extensions" do
 
     it "doesn't load the value into the association" do
       contacts = Contact.jit_preload.limit(2).to_a
+      expect(contacts.first.association(:addresses)).to_not be_loaded
+      expect(contacts.last.association(:addresses)).to_not be_loaded
+
       call(contacts.first)
 
       expect(contacts.first.association(:addresses)).to_not be_loaded
@@ -90,5 +93,18 @@ RSpec.describe "ActiveRecord::Base Extensions" do
         expect(contacts.last.association(:addresses)).to be_loaded
       end
     end
+
+    context "when no records exist for the association" do
+      let!(:record) { Parent.create }
+
+      it "returns an empty array" do
+        value = record.preload_scoped_relation(
+          name: "Parent Children",
+          base_association: :parents_child
+        )
+
+        expect(value).to eq([])
+      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
@@ -154,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
 
@@ -192,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] }
 
@@ -262,6 +288,22 @@ RSpec.describe JitPreloader::Preloader do
     end
   end
 
+  context "when a singular association id changes after preload" do
+    let!(:contact_book1) { ContactBook.create(name: "The Yellow Pages") }
+    let!(:contact_book2) { ContactBook.create(name: "The White Pages") }
+    let!(:company1) { Company.create(name: "Company1", contact_book: contact_book1) }
+    let!(:company2) { Company.create(name: "Company2", contact_book: contact_book1) }
+
+    it "allows the association to be reloaded" do
+      companies = Company.where(id: [company1.id, company2.id]).jit_preload.all.to_a
+      expect(companies.map(&:contact_book)).to match_array [contact_book1, contact_book1]
+
+      company = companies.each {|c| c.contact_book_id = contact_book2.id }
+
+      expect(companies.map(&:contact_book)).to match_array [contact_book2, contact_book2]
+    end
+  end
+
   context "when preloading an aggregate" do
     let(:addresses_counts) { [3, 0, 2] }
     let(:phone_number_counts) { [2, 0, 1] }

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
@@ -29,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,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -24,9 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -151,9 +151,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/CODEOWNERS"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Gemfile.5.2
+- Gemfile.5.2.lock
+- Gemfile.6.0
+- Gemfile.6.0.lock
+- Gemfile.6.1
+- Gemfile.6.1.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -193,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them