ar_lazy_preload 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d54ffe605f60682678626dc9fb88be7490cccc9d9d8e9d012e2118c97806531
-  data.tar.gz: d88d6afa1cd40385645771b6b8117df04e57af4753ab062c92a0dbe231836dc9
+  metadata.gz: 46e7c82ea00d2d4f0da30a522644d91b54f277a7e915d576c7e7fd959f5f3a12
+  data.tar.gz: c255f0fd18c255dc42bf4d321c598d4967960e5e4cb0370385e00b6b7b5963ea
 SHA512:
-  metadata.gz: b0865957982e3b35ab825b0a800c391a27989026865ca8efcd7c4b2f664e4054b2dcd92926ee3ed75ca81f2e4bc2d38fb61aa75f635f72256554fffd944eef93
-  data.tar.gz: b06ed1f0e44254b1d2e4660f0aa63e257c1dba54383e14d480c7852d92f3912a356e67f236f3e1107621db1a3b80a8abaf8ebbf31413f50f870ceb8c586aadfe
+  metadata.gz: fe5b062187652784cfd99ff7c201906400247204d77b91742d2350bf487f9542415f360808d6ad2dcc78f7f56aa496c1064781cebfd4122d6b6c1e706e079769
+  data.tar.gz: 7cc876e17f94ac05518654b9483a6a70c62b37e4226653ed323435aefa3d4544c6b722e82f3ecdba0af2b96513044d4ee02863d4b4b270d12579a6f3b7405ed8

data/README.md

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

@@ -47,8 +47,8 @@ module ArLazyPreload
         filtered_records = records.select do |record|
           reflection_names_cache[record.class].include?(association_name)
         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

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.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-03-04 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
@@ -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,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
@@ -210,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models
 test_files: []