ar_lazy_preload 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b1ef234e5a995bfce176e47fe5526fba9330b61cc27374e6667a5f5dfca3af
-  data.tar.gz: 3516b8bf449802b2ba3ff7022faec299ff274fe4716db884e46da63fe47d5ac9
+  metadata.gz: 780b04da1bdc2de0822bcf78d9ac51d7e24f5bf66aee70d42e81a0a0cb662a21
+  data.tar.gz: bceb49a3525fcfcac85d8662485992bc81e37015a9100a4332f3aaae1c0bd59e
 SHA512:
-  metadata.gz: 80a0a1e05b961a6d66b20c0b5e1a32ee2824d868e7e96d25e85b4e2b3c48baa1ee9129cf934b71e73a2887245faa9f54b3ecc23cc7815d60c30efc8bca9fbb7b
-  data.tar.gz: bbb5f854ed701c562d31f00cf3f832eb668c42aca809e4376aed4b78c114bd3c25db15edea712d65419a23c3fbbe1dfac5d698055dad5c5ae61ea837ea6fa273
+  metadata.gz: d32ee8fe923b29451f032ebb050168d6eaec8d5aec0b3136917a8196284198323ed804061bf64c7b36e104b95a43ced12372baa39a79976a1f69ae22a44c190c
+  data.tar.gz: d104a956772f064cb255db1f6743edd312da87da0526d2eff669976ce6f8537fb78a49cb302fa818942a4bb2bf1f0f0ae4226053c696e4575981aef774c356a9

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,8 +9,8 @@ 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
 
@@ -19,7 +19,7 @@ module ArLazyPreload
       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/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

@@ -45,10 +45,10 @@ module ArLazyPreload
 
       def perform_preloading(association_name)
         filtered_records = records.select do |record|
-          reflection_names_cache[record.class].include?(association_name)
+          preloadable_record?(association_name, record)
         end
-        preloader.preload(filtered_records, association_name)
 
+        preload_records(association_name, filtered_records)
         loaded_association_names.add(association_name)
 
         AssociatedContextBuilder.prepare(
@@ -57,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
@@ -69,11 +79,30 @@ module ArLazyPreload
         @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)
+      def preloadable_record?(association_name, record)
+        preloadable_reflections_cache.dig(record.class, association_name)
+      end
+
+      def preloadable_reflections_cache
+        @preloadable_reflections_cache ||= Hash.new do |hash, klass|
+          associations = klass.reflect_on_all_associations
+
+          hash[klass] = associations.each_with_object({}) do |reflection, cache|
+            cache[reflection.name] = preloadable_reflection?(klass, reflection)
+          end
         end
       end
+
+      def preloadable_reflection?(klass, reflection)
+        scope = reflection.scope
+        preloadable_scope = scope&.arity&.zero?
+        through_reflection =
+          reflection.options[:through] && klass.reflect_on_association(reflection.options[:through])
+        preloadable_through_reflection =
+          through_reflection && preloadable_reflection?(klass, through_reflection)
+
+        (!scope || preloadable_scope) && (!through_reflection || preloadable_through_reflection)
+      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.2"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2021-10-21 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: []