predictive_load 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bffe32fe50393ce8bb75bd01ae397084d3c2924ea4dafa9bccddb860baedf3
-  data.tar.gz: 1b37f4afd9874034fe0b7adc81317687d734cc51539665a5df005deefc0553c0
+  metadata.gz: f59d44d0c89dbf1ef633348451e1df43d6b059ddb50094549e2bc6a5f4843531
+  data.tar.gz: 75cd6c8518d8f200c13a8c52ed887b7e1a0d1e72aa02205305f7bc65d1b4b9ca
 SHA512:
-  metadata.gz: 8af3089f4ab81c3470d2811a335d40e36bede5ca38c59cf739135ebf4fdb18d7181338d9065a7fff06ff436a54c73e4ad618c61a890d8ee610c935855542e1da
-  data.tar.gz: de072a8eeaf0080dcf1bd2c1183b9b04f305c1206ed170737a6cbf97b62dee6945e876fb739b2495d715f9e1e373605383db35b13ed8ccb6b5a0f1bc71528e4c
+  metadata.gz: cfb8c2e28057981f773794139483805712c17faad421506c39d5309961b2be0c7d2b541c6afd4e0877f2e40703e3c036832651b6f569e57799d12ae0bd8ca20e
+  data.tar.gz: 49482a1ffcd183092f0f71242ab78fecca8b583a69aa8f90816173edcee4226f389061a36bccb27d455679132cb8dc6a756f6d3dc025293198213e5e7962cba4

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/eac/predictive_load.png)](https://travis-ci.org/eac/predictive_load)
+[![Build Status](https://github.com/zendesk/predictive_load/actions/workflows/actions.yml/badge.svg?branch=master)](https://github.com/zendesk/predictive_load/actions/workflows/actions.yml)
+
 
 predictive_load
 ===============
@@ -13,7 +14,7 @@ Observes Active Record collections and notifies when a member loads an associati
 ```ruby
 require 'predictive_load'
 require 'predictive_load/active_record_collection_observation'
-ActiveRecord::Base.send(:include, PredictiveLoad::ActiveRecordCollectionObservation)
+ActiveRecord::Base.include(PredictiveLoad::ActiveRecordCollectionObservation)
 
 require 'predictive_load/loader'
 

data/lib/predictive_load/active_record_collection_observation.rb

@@ -9,8 +9,8 @@ module PredictiveLoad::ActiveRecordCollectionObservation
     end
     ActiveRecord::Base.include CollectionMember
     ActiveRecord::Base.extend UnscopedTracker
-    ActiveRecord::Associations::Association.include AssociationNotification
-    ActiveRecord::Associations::CollectionAssociation.include CollectionAssociationNotification
+    ActiveRecord::Associations::Association.prepend AssociationNotification
+    ActiveRecord::Associations::CollectionAssociation.prepend CollectionAssociationNotification
   end
 
   module Rails5RelationObservation
@@ -45,18 +45,16 @@ module PredictiveLoad::ActiveRecordCollectionObservation
 
   # disable eager loading since includes + unscoped is broken on rails 4
   module UnscopedTracker
-    if ActiveRecord::VERSION::MAJOR >= 4
-      def unscoped
-        if block_given?
-          begin
-            predictive_load_disabled << self
-            super
-          ensure
-            predictive_load_disabled.pop
-          end
-        else
+    def unscoped
+      if block_given?
+        begin
+          predictive_load_disabled << self
           super
+        ensure
+          predictive_load_disabled.pop
         end
+      else
+        super
       end
     end
 
@@ -66,16 +64,10 @@ module PredictiveLoad::ActiveRecordCollectionObservation
   end
 
   module AssociationNotification
-
-    def self.included(base)
-      base.send(:alias_method, :load_target_without_notification, :load_target)
-      base.send(:alias_method, :load_target, :load_target_with_notification)
-    end
-
-    def load_target_with_notification
+    def load_target
       notify_collection_observer if find_target?
 
-      load_target_without_notification
+      super
     end
 
     protected
@@ -85,22 +77,14 @@ module PredictiveLoad::ActiveRecordCollectionObservation
         @owner.collection_observer.loading_association(@owner, self)
       end
     end
-
   end
 
   module CollectionAssociationNotification
-
-    def self.included(base)
-      base.send(:alias_method, :load_target_without_notification, :load_target)
-      base.send(:alias_method, :load_target, :load_target_with_notification)
-    end
-
-    def load_target_with_notification
+    def load_target
       notify_collection_observer if find_target?
 
-      load_target_without_notification
+      super
     end
-
   end
 
 end

data/lib/predictive_load/loader.rb

@@ -43,7 +43,7 @@ module PredictiveLoad
       return false if ActiveRecord::Base.predictive_load_disabled.include?(association.klass)
       return false if association.reflection.options[:predictive_load] == false
       return false if association.reflection.options[:conditions].respond_to?(:to_proc) # rails 3 conditions proc (we do not know if it uses instance methods)
-      if ActiveRecord::VERSION::MAJOR > 3 && scope = association.reflection.scope
+      if scope = association.reflection.scope
         if scope.is_a?(Proc)
           # rails 4+ conditions block, if it uses a passed in object, we assume it is not preloadable
           return false if scope.arity.to_i > 0
@@ -56,21 +56,24 @@ module PredictiveLoad
       true
     end
 
-    def preload(association_name)
-      # https://github.com/rails/rails/blob/v4.2.10/activerecord/lib/active_record/associations/preloader.rb#L187 (similar to other Rails versions)
-      # If the first record association is loaded, Preloader aborts.
-      #
-      # In a code like `comments.each { |c| c.user }, if the first comment user_id is nil,
-      # when calling the method (`user`) ActiveRecord doesn't load the association, but marks it as loaded.
-      # So when the second comment calls `user` (and user_id is not nil), @records.first will be the first
-      # comment above (with thr association already loaded), which will be checked by Preloader and used to skip
-      # any preloading.
-      #
-      # Fix is pretty simple, ignore any record with association already loaded.
-      rs = records_with_association(association_name).reject { |r| r.association(association_name).loaded? }
-      if ActiveRecord::VERSION::STRING <= "4.1.0"
-        ActiveRecord::Associations::Preloader.new(rs, [ association_name ]).run
-      else
+    # https://github.com/rails/rails/blob/v4.2.10/activerecord/lib/active_record/associations/preloader.rb#L187 (similar to other Rails versions)
+    # If the first record association is loaded, Preloader aborts.
+    #
+    # In a code like `comments.each { |c| c.user }, if the first comment user_id is nil,
+    # when calling the method (`user`) ActiveRecord doesn't load the association, but marks it as loaded.
+    # So when the second comment calls `user` (and user_id is not nil), @records.first will be the first
+    # comment above (with thr association already loaded), which will be checked by Preloader and used to skip
+    # any preloading.
+    #
+    # Fix is pretty simple, ignore any record with association already loaded.
+    if ActiveRecord::VERSION::MAJOR >= 7
+      def preload(association_name)
+        rs = records_with_association(association_name).reject { |r| r.association(association_name).loaded? }
+        ActiveRecord::Associations::Preloader.new(records: rs, associations: [association_name]).call
+      end
+    else
+      def preload(association_name)
+        rs = records_with_association(association_name).reject { |r| r.association(association_name).loaded? }
         ActiveRecord::Associations::Preloader.new.preload(rs, [ association_name ])
       end
     end

data/lib/predictive_load/preload_log.rb

@@ -8,16 +8,14 @@ module PredictiveLoad
     def preload(association)
       grouped_records(association).each do |reflection, klasses|
         klasses.each do |klass, records|
-          preload_scope = (ActiveRecord::VERSION::MAJOR == 3 ? options : self.preload_scope)
-          preloader   = preloader_for(reflection).new(klass, records, reflection, preload_scope)
+          preloader = preloader_for(reflection).new(klass, records, reflection, preload_scope)
 
           if preloader.respond_to?(:through_reflection)
             log("encountered :through association for #{association}. Requires loading records to generate query, so skipping for now.")
             next
           end
 
-          scope = (ActiveRecord::VERSION::MAJOR == 3 ? preloader.scoped : preloader.scope)
-          preload_sql = scope.where(collection_arel(preloader)).to_sql
+          preload_sql = preloader.scope.where(collection_arel(preloader)).to_sql
 
           log("would preload with: #{preload_sql.to_s}")
           klass.connection.explain(preload_sql).each_line do |line|

data/lib/predictive_load.rb

@@ -1,18 +1,13 @@
 module PredictiveLoad
-
-end
-
-klasses = [ActiveRecord::Associations::Builder::Association]
-
-if ActiveRecord::VERSION::MAJOR == 3
-  # when belongs_to etc is loaded before us it already made a copy of valid_options
-  klasses.concat ActiveRecord::Associations::Builder::Association.descendants
+  module Rails5AssociationOptions
+    def valid_options(options)
+      super + [:predictive_load]
+    end
+  end
 end
 
-klasses.each do |klass|
-  if ActiveRecord::VERSION::MAJOR < 5
-    klass.valid_options << :predictive_load
-  else
-    klass::VALID_OPTIONS << :predictive_load
-  end
+if ActiveRecord::VERSION::MAJOR >= 5
+  ActiveRecord::Associations::Builder::Association.singleton_class.prepend(PredictiveLoad::Rails5AssociationOptions)
+else
+  ActiveRecord::Associations::Builder::Association.valid_options << :predictive_load
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: predictive_load
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Chapweske
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7.1'
 description: Predictive loader
 email:
 - eac@zendesk.com
@@ -47,7 +47,7 @@ homepage: https://github.com/zendesk/predictive_load
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []