ar_lazy_preload 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 302e5031cc0d1046c7ef7400dca6767fb13e4f8e68ba98a7cfa20b648f64d60a
-  data.tar.gz: 40cc089d2e4863636d21f13bc9273f0c1341c209275d9162e6ce3ecad05c7e24
+  metadata.gz: 46e7c82ea00d2d4f0da30a522644d91b54f277a7e915d576c7e7fd959f5f3a12
+  data.tar.gz: c255f0fd18c255dc42bf4d321c598d4967960e5e4cb0370385e00b6b7b5963ea
 SHA512:
-  metadata.gz: 00b77bb2a441ad78f74d96776d36073dbdcc29d811d98de5430ec750217c4f6d8bbf103465debd67c67fd3d86a296f8ab39d2d3e098f193fb348657d0d38c30f
-  data.tar.gz: 0e06520adf62f0bb9f0a1bb7b6d9d667b4478b206a4ffcb1e7c40efd2314d7d0205e72cc27bbb214a1a93e6a3d4a5cd5c5def11d458dfcb3054bd4240162c818
+  metadata.gz: fe5b062187652784cfd99ff7c201906400247204d77b91742d2350bf487f9542415f360808d6ad2dcc78f7f56aa496c1064781cebfd4122d6b6c1e706e079769
+  data.tar.gz: 7cc876e17f94ac05518654b9483a6a70c62b37e4226653ed323435aefa3d4544c6b722e82f3ecdba0af2b96513044d4ee02863d4b4b270d12579a6f3b7405ed8

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

@@ -16,6 +16,7 @@ module ArLazyPreload
 
     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)

data/lib/ar_lazy_preload/active_record/collection_association.rb

@@ -3,7 +3,7 @@
 module ArLazyPreload
   # ActiveRecord::CollectionAssociation patch with a hook for lazy preloading
   module CollectionAssociation
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
     def ids_reader
       return super if owner.lazy_preload_context.blank?
 
@@ -16,6 +16,6 @@ module ArLazyPreload
         @association_ids ||= reader.map(&primary_key)
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize
   end
 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

@@ -8,8 +8,8 @@ module ArLazyPreload
   # the associated records based on the parent association tree.
   class AssociatedContextBuilder
     # Initiates lazy preload context the records loaded lazily
-    def self.prepare(*args)
-      new(*args).perform
+    def self.prepare(**args)
+      new(**args).perform
     end
 
     attr_reader :parent_context, :association_name
@@ -23,12 +23,15 @@ module ArLazyPreload
 
     # Takes all the associated records for the records, attached to the :parent_context and creates
     # a preloading context for them
-    def perform # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def perform
       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
 
@@ -38,6 +41,7 @@ module ArLazyPreload
         auto_preload: parent_context.auto_preload?
       )
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 

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.4.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.4.0
+  version: 0.6.1
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 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
@@ -54,6 +54,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+- !ruby/object:Gem::Dependency
+  name: db-query-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: db-query-matchers
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  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.0.3
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models
 test_files: []