predictive_load 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b0c3352a1804088cd709d17e619ff406cc243a92ef5b180815416e704b89775
-  data.tar.gz: b12b98881fccee776a2cf2175a8c2d4c06eb6325d1d5a47c08a732f5b6c2eb51
+  metadata.gz: 93ddc441f98b6e7f9ec3b9a4277b5bf91cad8d360564e2c46dfae3a4963e647b
+  data.tar.gz: 05c1fc9459671d0cad41b68c9f6e5e5003e006ba582a5fedf3b63aca379a85fa
 SHA512:
-  metadata.gz: a67ac4027e5b1f8c5d70b4799f7cbd230c18c0b18a2100085c1876a97ece7b283b621a22981ac5f1e0d16e6c0f6383746d436080f57a2b1810a216230c20a74e
-  data.tar.gz: baa04313709dd51cbe4269a9cf536559d88ea24d55409a0ba80dd9f1f1db9fa4b1f4ee03df9df57841bb5abe81250255bbb9b257d55fcd6e9f653b5dbc2479d2
+  metadata.gz: a6b4e23f4c7cbb1d4751e7aef27fabaa1e5ccb337276788489b08c031b0f3a9b9b3ac318328215579d78b2477ac95148af1dfa350a0635cb98959bb28c76b296
+  data.tar.gz: 8d836cbd60a8798408752818ec84b08165d27f9196645129683a1c15abd43288976575ad0e57c737c93e9169b9995a065c3d1bfea2a962da4b39f62d25f53a07

data/README.md

@@ -14,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'
 
@@ -45,4 +45,3 @@ has_many :foos, predictive_load: false
 
 * Calling association#size will trigger an N+1 on SELECT COUNT(*). Work around by calling #length, loading all records.
 * Calling first / last will trigger an N+1.
-* Rails 4: unscoped will disable eager loading to circument a rails bug ... hopefully fixed in rails 5 https://github.com/rails/rails/pull/16531

data/lib/predictive_load/active_record_collection_observation.rb

@@ -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
 

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.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Eric Chapweske
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2023-05-05 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.0
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '6.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
@@ -55,16 +55,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: ''
 test_files: []