ar_lazy_preload 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d54ffe605f60682678626dc9fb88be7490cccc9d9d8e9d012e2118c97806531
-  data.tar.gz: d88d6afa1cd40385645771b6b8117df04e57af4753ab062c92a0dbe231836dc9
+  metadata.gz: 853f4f5f10ba5f9aa5e6530eb767f9d4063d62745b2b332776c7ebb44c753700
+  data.tar.gz: ff2f6a626e8e944734dcab46eef9677bda77582027f1e687b27b616a5cdac0cb
 SHA512:
-  metadata.gz: b0865957982e3b35ab825b0a800c391a27989026865ca8efcd7c4b2f664e4054b2dcd92926ee3ed75ca81f2e4bc2d38fb61aa75f635f72256554fffd944eef93
-  data.tar.gz: b06ed1f0e44254b1d2e4660f0aa63e257c1dba54383e14d480c7852d92f3912a356e67f236f3e1107621db1a3b80a8abaf8ebbf31413f50f870ceb8c586aadfe
+  metadata.gz: f873a03ba3abc319042f601e512b48b64d638f3b6358e722768e92745992c654f4aef229e792690c0c250563c9f28ae2d69fd77931c9af27db9a09f719f6341f
+  data.tar.gz: 521c1bf8d19bc8bc2c5e71c8fd2918ac400102368016a9d6448b19426bcefc569b51fda0e13b205d86a872553f08a619a436fb3c7821bb4b866056c771065121

data/README.md

@@ -1,9 +1,9 @@
-# ArLazyPreload [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/activerecord-lazy-preload.html) [![Gem Version](https://badge.fury.io/rb/ar_lazy_preload.svg)](https://rubygems.org/gems/ar_lazy_preload) [![Build Status](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload.svg?branch=master)](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload) [![Maintainability](https://api.codeclimate.com/v1/badges/00d04595661820dfba80/maintainability)](https://codeclimate.com/github/DmitryTsepelev/ar_lazy_preload/maintainability) [![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/ar_lazy_preload/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/ar_lazy_preload?branch=master)
+# ArLazyPreload [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/activerecord-lazy-preload.html) [![Gem Version](https://badge.fury.io/rb/ar_lazy_preload.svg)](https://rubygems.org/gems/ar_lazy_preload) [![Build Status](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/rspec.yml/badge.svg)](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/rspec.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/00d04595661820dfba80/maintainability)](https://codeclimate.com/github/DmitryTsepelev/ar_lazy_preload/maintainability) [![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/ar_lazy_preload/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/ar_lazy_preload?branch=master)
 
 **ArLazyPreload** is a gem that brings association lazy load functionality to your Rails applications. There is a number of built-in methods to solve [N+1 problem](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations), but sometimes a list of associations to preload is not obvious–this is when you can get most of this gem.
 
 - **Simple**. The only thing you need to change is to use `#lazy_preload` instead of `#includes`, `#eager_load` or `#preload`
-- **Fast**. Take a look at [benchmarks](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload) (`TASK=bench` and `TASK=memory`)
+- **Fast**. Take a look at [performance benchmark](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/bench.yml) and [memory benchmark](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/memory.yml)
 - **Perfect fit for GraphQL**. Define a list of associations to load at the top-level resolver and let the gem do its job
 - **Auto-preload support**. If you don't want to specify the association list–set `ArLazyPreload.config.auto_preload` to `true`
 
@@ -62,7 +62,7 @@ posts = User.preload_associations_lazily.flat_map(&:posts)
 
 ## Gotchas
 
-1. Lazy preloading [does not work](https://github.com/DmitryTsepelev/ar_lazy_preload/pull/40/files) when `.includes` is called earlier:
+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|

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,25 @@
 # 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?
+
+      preload.each do |associations|
+        ArLazyPreload::Preloader.new(records, associations).preload.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 +88,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

@@ -2,6 +2,7 @@
 
 require "set"
 require "ar_lazy_preload/associated_context_builder"
+require "ar_lazy_preload/preloader"
 
 module ArLazyPreload
   module Contexts
@@ -45,10 +46,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 +58,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
+          ArLazyPreload::Preloader.new(records, [association_name]).preload
+        end
+      end
+
       def association_loaded?(association_name)
         loaded_association_names.include?(association_name)
       end
@@ -65,15 +76,30 @@ module ArLazyPreload
         @loaded_association_names ||= Set.new
       end
 
-      def preloader
-        @preloader ||= ActiveRecord::Associations::Preloader.new
+      def preloadable_record?(association_name, record)
+        preloadable_reflections_cache.dig(record.class, association_name)
       end
 
-      def reflection_names_cache
-        @reflection_names_cache ||= Hash.new do |hash, klass|
-          hash[klass] = klass.reflect_on_all_associations.map(&:name)
+      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/preloader.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  class Preloader
+    def initialize(records, associations)
+      @records = records
+      @associations = associations
+    end
+
+    class << self
+      def patch_for_rails_7!
+        define_method(:preload) do
+          ActiveRecord::Associations::Preloader.new(
+            records: @records, associations: @associations
+          ).call
+        end
+      end
+    end
+
+    def preload
+      ActiveRecord::Associations::Preloader.new.preload(@records, @associations)
+    end
+  end
+end

data/lib/ar_lazy_preload/railtie.rb

@@ -25,6 +25,8 @@ module ArLazyPreload
 
         ActiveRecord::Associations::CollectionAssociation.prepend(CollectionAssociation)
         ActiveRecord::Associations::CollectionProxy.prepend(CollectionProxy)
+
+        ArLazyPreload::Preloader.patch_for_rails_7! if ActiveRecord::VERSION::MAJOR >= 7
       end
     end
   end

data/lib/ar_lazy_preload/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-12-29 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.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,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
@@ -189,6 +203,9 @@ 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/preloader.rb
 - lib/ar_lazy_preload/railtie.rb
 - lib/ar_lazy_preload/version.rb
 homepage: https://github.com/DmitryTsepelev/ar_lazy_preload
@@ -203,14 +220,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models