ar_lazy_preload 0.5.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122262e10bed3d8a2793e62f24ee39e7a01453933c68d8faffce8945b794a522
-  data.tar.gz: e50652dd855cbbbe39b292b20e07fca7f43ba660fd2f28f0c41de1fa0595c281
+  metadata.gz: d3b1c23e853fd6612e6d7f4f063e4cac5577c591a9a3b7be3b04c4a6801d1291
+  data.tar.gz: 66a30a3b81d996ebbb9324dfedf4f874498da1b202f66dcab17385fc8596bde3
 SHA512:
-  metadata.gz: 97a5044a80f021ea4f4c0bd0b27b0881858371bb60051014f885c791570346bafae8c2e4110f5f492817cbe38d44c551a4045d886a67e1ede30a5af5079afdac
-  data.tar.gz: '0458891f44c12464f6ce33295c6ef4e20bf55df63dc81a46ad840401cb47f1a782c466ee87f4c44c965b5090bc1c02ed2bead8a90f9b5031f9665803ade8e0a6'
+  metadata.gz: 7fae1e071f6f199d8a881a2bf0a60a4b5d53e1467428d07e39d67d98539a20a9b8b319ac4aac7ba73675367c648db441a7eb24bcf1f252c0becddd7905150d9c
+  data.tar.gz: 7c5107b91f3671cc4fa16ae38af7a8b54832c31afc10e337c76eb3b4f24440eff87d5202577bbbcef38628f3266af057966a4120097c8cf887524a8c8ce03ba3

data/README.md

@@ -60,6 +60,19 @@ posts = User.preload_associations_lazily.flat_map(&:posts)
 # => SELECT * FROM posts WHERE user_id in (...)
 ```
 
+## Gotchas
+
+1. Lazy preloading [does not work](https://github.com/DmitryTsepelev/ar_lazy_preload/pull/40/files) for ActiveRecord < 6 when `.includes` is called earlier:
+
+  ```ruby
+  Post.includes(:user).preload_associations_lazily.each do |p|
+    p.user.comments.load
+  end
+  ```
+
+2. When `#size` is called on association (e.g., `User.lazy_preload(:posts).map { |u| u.posts.size }`), lazy preloading won't happen, because `#size` method performs `SELECT COUNT()` database request instead of loading the association when association haven't been loaded yet ([here](https://github.com/DmitryTsepelev/ar_lazy_preload/pull/42) is the issue, and [here](https://blazarblogs.wordpress.com/2019/07/27/activerecord-size-vs-count-vs-length/) is the explanation article about `size`, `length` and `count`).
+
+
 ## Installation
 
 Add this line to your application's Gemfile, and you're all set:

data/lib/ar_lazy_preload/active_record/association_relation.rb

@@ -9,16 +9,17 @@ module ArLazyPreload
       setup_preloading_context unless ArLazyPreload.config.auto_preload?
     end
 
-    delegate :owner, :reflection, to: :proxy_association
-    delegate :lazy_preload_context, to: :owner
+    delegate :owner, :reflection, to: :proxy_association, prefix: true
+    delegate :lazy_preload_context, to: :proxy_association_owner
 
     private
 
     def setup_preloading_context
       return if lazy_preload_context.nil?
+      return if lazy_preload_context.association_tree.nil?
 
       association_tree_builder = AssociationTreeBuilder.new(lazy_preload_context.association_tree)
-      subtree = association_tree_builder.subtree_for(reflection.name)
+      subtree = association_tree_builder.subtree_for(proxy_association_reflection.name)
 
       lazy_preload!(subtree)
     end

data/lib/ar_lazy_preload/active_record/relation.rb

@@ -1,12 +1,27 @@
 # frozen_string_literal: true
 
 require "ar_lazy_preload/context"
+require "ar_lazy_preload/contexts/temporary_preload_config"
+require "ar_lazy_preload/preloaded_records_converter"
 
 module ArLazyPreload
   # ActiveRecord::Relation patch with lazy preloading support
   module Relation
     attr_writer :preloads_associations_lazily
 
+    def preload_associations(records)
+      preload = preload_values
+      preload += includes_values unless eager_loading?
+      preloader = nil
+      preload.each do |associations|
+        preloader ||= build_preloader
+        preloader_associations = preloader.preload records, associations
+        preloader_associations.each do |preloader_association|
+          handle_preloaded_records(preloader_association.preloaded_records)
+        end
+      end
+    end
+
     # Enhanced #load method will check if association has not been loaded yet and add a context
     # for lazy preloading to loaded each record
     def load
@@ -75,6 +90,20 @@ module ArLazyPreload
       @preloads_associations_lazily ||= false
     end
 
+    def handle_preloaded_records(preloaded_records)
+      return unless Contexts::TemporaryPreloadConfig.enabled? || preloads_associations_lazily?
+
+      records_array = PreloadedRecordsConverter.call(preloaded_records)
+
+      return unless records_array&.any?
+
+      Context.register(
+        records: records_array,
+        association_tree: lazy_preload_values,
+        auto_preload: true
+      )
+    end
+
     attr_writer :lazy_preload_values
   end
 end

data/lib/ar_lazy_preload/associated_context_builder.rb

@@ -28,8 +28,10 @@ module ArLazyPreload
       associated_records = parent_context.records.flat_map do |record|
         next if record.nil?
 
-        record_association = record.association(association_name)
         reflection = reflection_cache[record.class]
+        next if reflection.nil?
+
+        record_association = record.association(association_name)
         reflection.collection? ? record_association.target : record_association.reader
       end
 

data/lib/ar_lazy_preload/context.rb

@@ -3,6 +3,7 @@
 require "ar_lazy_preload/contexts/base_context"
 require "ar_lazy_preload/contexts/auto_preload_context"
 require "ar_lazy_preload/contexts/lazy_preload_context"
+require "ar_lazy_preload/contexts/temporary_preload_config"
 
 module ArLazyPreload
   class Context

data/lib/ar_lazy_preload/contexts/base_context.rb

@@ -19,6 +19,9 @@ module ArLazyPreload
         @records.each { |record| record.lazy_preload_context = self }
       end
 
+      # @api
+      def association_tree; nil; end
+
       # This method checks if the association should be loaded and preloads it for all
       # objects in the context it if needed.
       def try_preload_lazily(association_name)
@@ -41,7 +44,11 @@ module ArLazyPreload
       private
 
       def perform_preloading(association_name)
-        preloader.preload(records, association_name)
+        filtered_records = records.select do |record|
+          reflection_names_cache[record.class].include?(association_name)
+        end
+
+        preload_records(association_name, filtered_records)
         loaded_association_names.add(association_name)
 
         AssociatedContextBuilder.prepare(
@@ -50,6 +57,16 @@ module ArLazyPreload
         )
       end
 
+      # Method preloads associations for the specific sets of the records
+      # and provides automatically provides context for the records
+      # loaded using `includes` inside Relation#preload_associations with the
+      # help of the TemporaryPreloadConfig
+      def preload_records(association_name, records)
+        TemporaryPreloadConfig.within_context do
+          preloader.preload(records, association_name)
+        end
+      end
+
       def association_loaded?(association_name)
         loaded_association_names.include?(association_name)
       end
@@ -61,6 +78,12 @@ module ArLazyPreload
       def preloader
         @preloader ||= ActiveRecord::Associations::Preloader.new
       end
+
+      def reflection_names_cache
+        @reflection_names_cache ||= Hash.new do |hash, klass|
+          hash[klass] = klass.reflect_on_all_associations.map(&:name)
+        end
+      end
     end
   end
 end

data/lib/ar_lazy_preload/contexts/temporary_preload_config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  module Contexts
+    # Preload config that used to enable preloading only for specfic part of the application
+    class TemporaryPreloadConfig
+      THREAD_KEY = "temporary_preload_context_enabled"
+
+      class << self
+        def enabled?
+          Thread.current[THREAD_KEY] == true
+        end
+
+        def within_context
+          Thread.current[THREAD_KEY] = true
+          yield
+        ensure
+          Thread.current[THREAD_KEY] = nil
+        end
+      end
+    end
+  end
+end

data/lib/ar_lazy_preload/preloaded_records_converter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  class PreloadedRecordsConverter
+    # For different versions of rails we have different records class
+    # for ~> 6.1.0 it returns plain array
+    # for ~> 6.0.0 it returns ActiveRecord::Relation
+    def self.call(preloaded_records)
+      case preloaded_records
+      when Array
+        preloaded_records
+      when ::ActiveRecord::Relation
+        raise(ArgumentError, "The relation is not preloaded") unless preloaded_records.loaded?
+
+        preloaded_records.to_a
+      else
+        raise(ArgumentError, "Unsupported class for preloaded records")
+      end
+    end
+  end
+end

data/lib/ar_lazy_preload/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArLazyPreload
-  VERSION = "0.5.0"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: lazy_preload implementation for ActiveRecord models
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -175,13 +203,15 @@ files:
 - lib/ar_lazy_preload/contexts/auto_preload_context.rb
 - lib/ar_lazy_preload/contexts/base_context.rb
 - lib/ar_lazy_preload/contexts/lazy_preload_context.rb
+- lib/ar_lazy_preload/contexts/temporary_preload_config.rb
+- lib/ar_lazy_preload/preloaded_records_converter.rb
 - lib/ar_lazy_preload/railtie.rb
 - lib/ar_lazy_preload/version.rb
 homepage: https://github.com/DmitryTsepelev/ar_lazy_preload
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models
 test_files: []