jit_preloader 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca887aa87a283d55ee26b1fe606948733ecfecc7ce40d4cedc8b89d90efb834
-  data.tar.gz: 9a7c463ccacf8daeebc23d2eaa375d8c4f908b333c492baaa4c4c931bbc7d1b3
+  metadata.gz: dac1fcb3b291d3064e2f06455c08d0b25d7c4875bb4f7c5938c194c6ca9dc232
+  data.tar.gz: 5704f5b84dfd9b99898bf145622cd3175afbbf5a4cee3ecb2a4599d7a7e5fbc5
 SHA512:
-  metadata.gz: 30920baa0426de8bc5188fc80ccfacf6e040f6bf1f7c934214bb75600080a090756ca957da9a59327a63b30550d7a4efdf5f4e66c873783e0c5aa627fe558e9f
-  data.tar.gz: 9adfa72af9bfcc684c3c22f6e82b353af9b36081224cae92e248e5c52db7f028a9c6f49dc3760d059f476980a48f4852b6f94c5e5faf82dbef28087e0b8dd3cd
+  metadata.gz: e1b603e9e2fc4748b8765b8329ac435a17cdf5753b9a69479c44fdd78f3398293e1ffccd666667bf93a83db15dc326fa9d389a06bc930d00998032111c2dcea4
+  data.tar.gz: 88c93ec8fb2ad3e24b2209ed4c456389b0f93c0b8b729f60ccccd5f00e7960cb12251f4cfaf364d0f718cfe788803cc2dbd55799ae61832d2ee3f07d6291fe50

data/.github/workflows/ci.yml

@@ -9,13 +9,12 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     strategy:
       fail-fast: false
       matrix:
         gemfile:
           - Gemfile
-          - Gemfile.5.2
-          - Gemfile.6.0
           - Gemfile.6.1
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -24,7 +23,7 @@ jobs:
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1
       - name: Install dependencies
         run: bundle install
       - name: Run tests

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

@@ -13,10 +13,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Ruby 2.7
+    - name: Set up Ruby 3.1
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.1
 
     - name: Publish to RubyGems
       env:

data/.gitignore

@@ -50,3 +50,4 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.ruby-version

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem "activerecord", ">=7"
+gem "sqlite3", "~> 1.4"
 # Specify your gem's dependencies in jit_preloader.gemspec
 gemspec

data/jit_preloader.gemspec

@@ -10,7 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["kyle.doliveira@clio.com"]
   spec.summary       = %q{Tool to understand N+1 queries and to remove them}
   spec.description   = %q{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}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/clio/jit_preloader"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

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

@@ -18,13 +18,17 @@ module JitPreloader
           # always an N+1 query.
           record.jit_n_plus_one_tracking ||= owner.jit_n_plus_one_tracking if record
 
-          if !jit_loaded && owner.jit_n_plus_one_tracking
+          if !jit_loaded && owner.jit_n_plus_one_tracking && !is_polymorphic_association_without_type
             ActiveSupport::Notifications.publish("n_plus_one_query",
                                                  source: owner, association: reflection.name)
           end
         end
       end
     end
+    
+    private def is_polymorphic_association_without_type
+      self.is_a?(ActiveRecord::Associations::BelongsToPolymorphicAssociation) && self.klass.nil?
+    end
   end
 end
 

data/lib/jit_preloader/active_record/base.rb

@@ -22,6 +22,7 @@ module JitPreloadExtension
     def preload_scoped_relation(name:, base_association:, preload_scope: nil)
       return jit_preload_scoped_relations[name] if jit_preload_scoped_relations&.key?(name)
 
+      base_association = base_association.to_sym
       records = jit_preloader&.records || [self]
       previous_association_values = {}
 
@@ -55,6 +56,7 @@ module JitPreloadExtension
     def preload_scoped_relation(name:, base_association:, preload_scope: nil)
       return jit_preload_scoped_relations[name] if jit_preload_scoped_relations&.key?(name)
 
+      base_association = base_association.to_sym
       records = jit_preloader&.records || [self]
       previous_association_values = {}
 

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "2.1.0"
+  VERSION = "3.1.0"
 end

data/lib/jit_preloader.rb

@@ -11,10 +11,8 @@ require 'jit_preloader/active_record/associations/singular_association'
 if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("7.0.0")
   require 'jit_preloader/active_record/associations/preloader/ar7_association'
   require 'jit_preloader/active_record/associations/preloader/ar7_branch'
-elsif Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("6.0.0")
+elsif Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new("6.1.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'

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

@@ -106,5 +106,27 @@ RSpec.describe "ActiveRecord::Base Extensions" do
         expect(value).to eq([])
       end
     end
+
+    context "when preload_scoped_relation with string base_association name" do
+      it "preload properly" do
+        contacts = Contact.jit_preload.limit(2).to_a
+
+        call_with_string = lambda { |contact| contact.preload_scoped_relation(
+          name: "American Addresses",
+          base_association: "addresses",
+          preload_scope: Address.where(country: usa)
+        ) }
+
+        usa_addresses = contacts.first.addresses.where(country: usa).to_a
+        expect do
+          expect(call_with_string.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_with_string.call(contacts.last)).to match_array usa_addresses
+        end.to_not make_database_queries
+      end
+    end
   end
 end

data/spec/lib/jit_preloader/preloader_spec.rb

@@ -165,6 +165,30 @@ RSpec.describe JitPreloader::Preloader do
           expect(Contact.jit_preload.map(&:contact_owner)).to eq [nil, ContactOwner.first, Address.first]
         end
       end
+
+      context "when a record has a polymorphic association type is nil" do
+        before do
+          contact1.update!(contact_owner_type: nil, contact_owner_id: nil)
+        end
+
+        it "successfully load the rest of association values and does not publish a n+1 notification" do
+          contacts = Contact.jit_preload.to_a
+          ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+            expect(contacts.first.contact_owner).to eq(nil)
+          end
+
+          expect(source_map).to eql({})
+
+          expect do
+            contacts.first.contact_owner
+            contacts.second.contact_owner
+            contacts.third.contact_owner
+          end.not_to make_database_queries
+
+          expect(contacts.second.contact_owner).to eq(ContactOwner.first)
+          expect(contacts.third.contact_owner).to eq(Address.first)
+        end
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -151,8 +151,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.5.2
-- Gemfile.5.2.lock
 - Gemfile.6.0
 - Gemfile.6.0.lock
 - Gemfile.6.1
@@ -163,7 +161,6 @@ files:
 - jit_preloader.gemspec
 - lib/jit_preloader.rb
 - lib/jit_preloader/active_record/associations/collection_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/ar7_association.rb
 - lib/jit_preloader/active_record/associations/preloader/ar7_branch.rb
@@ -179,10 +176,12 @@ files:
 - spec/spec_helper.rb
 - spec/support/database.rb
 - spec/support/models.rb
-homepage: ''
+homepage: https://github.com/clio/jit_preloader
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/clio/jit_preloader
+  source_code_uri: https://github.com/clio/jit_preloader
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them

data/Gemfile.5.2

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

data/Gemfile.5.2.lock

@@ -1,72 +0,0 @@
-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/lib/jit_preloader/active_record/associations/preloader/ar5_association.rb

@@ -1,66 +0,0 @@
-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(preloader)
-    #   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
-
-    #   owners.each do |owner|
-    #     associate_records_to_owner(owner, records[convert_key(owner[owner_key_name])] || [])
-    #   end
-    # 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?
-        end
-      end
-    end
-
-    # Original method:
-    # def associate_records_to_owner(owner, records)
-    #   association = owner.association(reflection.name)
-    #   association.loaded!
-    #   if reflection.collection?
-    #     association.target.concat(records)
-    #   else
-    #     association.target = records.first unless records.empty?
-    #   end
-    # end
-    def associate_records_to_owner(owner, records)
-      association = owner.association(reflection.name)
-      association.loaded!
-
-      if reflection.collection?
-        # It is possible that some of the records are loaded already.
-        # We don't want to duplicate them, but we also want to preserve
-        # 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
-    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)