ar_lazy_preload 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e0b3d4a8e8ac0c7c3824058347406f2ede573183f085b40acfd288e2b43014
-  data.tar.gz: d47fa44acb9b48181ac97c4c77138977375e1f593b4eaee4673314895836220f
+  metadata.gz: 3d54ffe605f60682678626dc9fb88be7490cccc9d9d8e9d012e2118c97806531
+  data.tar.gz: d88d6afa1cd40385645771b6b8117df04e57af4753ab062c92a0dbe231836dc9
 SHA512:
-  metadata.gz: 73f6f5dd9b745e262d5e2e1e6532f266c65eda63282938e2b08838cbb1bf4e161df8a38d208c436714967d13ef2579a6398c492b3690f98d5d9a082169d93065
-  data.tar.gz: 5f084968e4c8aacdf438ab08f94e2768f9090185e91c1ce4e9f7841558d0541b42f8e3b9926df85191d634b01cbcb1aab9e7702b77a2eb438cf0b732017e9322
+  metadata.gz: b0865957982e3b35ab825b0a800c391a27989026865ca8efcd7c4b2f664e4054b2dcd92926ee3ed75ca81f2e4bc2d38fb61aa75f635f72256554fffd944eef93
+  data.tar.gz: b06ed1f0e44254b1d2e4660f0aa63e257c1dba54383e14d480c7852d92f3912a356e67f236f3e1107621db1a3b80a8abaf8ebbf31413f50f870ceb8c586aadfe

data/README.md

@@ -50,6 +50,29 @@ If you want to turn automatic preload off for a specific record, you can call `.
 users.first.skip_preload.posts # => SELECT * FROM posts WHERE user_id = ?
 ```
 
+### Relation auto preloading
+
+Another alternative for auto preloading is using relation `#preload_associations_lazily` method
+
+```ruby
+posts = User.preload_associations_lazily.flat_map(&:posts)
+# => SELECT * FROM users LIMIT 10
+# => SELECT * FROM posts WHERE user_id in (...)
+```
+
+## Gotchas
+
+1. Lazy preloading [does not work](https://github.com/DmitryTsepelev/ar_lazy_preload/pull/40/files) 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/base.rb

@@ -5,6 +5,7 @@ module ArLazyPreload
   module Base
     def self.included(base)
       base.class.delegate :lazy_preload, to: :all
+      base.class.delegate :preload_associations_lazily, to: :all
     end
 
     attr_accessor :lazy_preload_context

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

@@ -5,6 +5,8 @@ require "ar_lazy_preload/context"
 module ArLazyPreload
   # ActiveRecord::Relation patch with lazy preloading support
   module Relation
+    attr_writer :preloads_associations_lazily
+
     # 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
@@ -13,12 +15,25 @@ module ArLazyPreload
       if need_context
         Context.register(
           records: ar_lazy_preload_records,
-          association_tree: lazy_preload_values
+          association_tree: lazy_preload_values,
+          auto_preload: preloads_associations_lazily?
         )
       end
       result
     end
 
+    # Lazily autoloads all associations. For example:
+    #
+    #   users = User.preload_associations_lazily
+    #   users.each do |user|
+    #     user.posts.flat_map {|post| post.comments.map(&:id)}
+    #   end
+    #
+    # Same effect can be achieved by User.lazy_preload(posts: :comments)
+    def preload_associations_lazily
+      spawn.tap { |relation| relation.preloads_associations_lazily = true }
+    end
+
     # Specify relationships to be loaded lazily when association is loaded for the first time. For
     # example:
     #
@@ -56,6 +71,10 @@ module ArLazyPreload
       @records
     end
 
+    def preloads_associations_lazily?
+      @preloads_associations_lazily ||= false
+    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,23 +23,31 @@ module ArLazyPreload
 
     # Takes all the associated records for the records, attached to the :parent_context and creates
     # a preloading context for them
+    # 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
 
-      Context.register(records: associated_records, association_tree: child_association_tree)
+      Context.register(
+        records: associated_records,
+        association_tree: child_association_tree,
+        auto_preload: parent_context.auto_preload?
+      )
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 
     def child_association_tree
       # `association_tree` is unnecessary when auto preload is enabled
-      return nil if ArLazyPreload.config.auto_preload?
+      return nil if parent_context.auto_preload?
 
       AssociationTreeBuilder.new(parent_context.association_tree).subtree_for(association_name)
     end

data/lib/ar_lazy_preload/context.rb

@@ -7,10 +7,10 @@ require "ar_lazy_preload/contexts/lazy_preload_context"
 module ArLazyPreload
   class Context
     # Initiates lazy preload context for given records
-    def self.register(records:, association_tree:)
+    def self.register(records:, association_tree:, auto_preload: false)
       return if records.empty?
 
-      if ArLazyPreload.config.auto_preload?
+      if ArLazyPreload.config.auto_preload? || auto_preload
         Contexts::AutoPreloadContext.new(records: records)
       elsif association_tree.any?
         Contexts::LazyPreloadContext.new(

data/lib/ar_lazy_preload/contexts/auto_preload_context.rb

@@ -4,6 +4,10 @@ module ArLazyPreload
   module Contexts
     # This class is responsible for automatic association preloading
     class AutoPreloadContext < BaseContext
+      def auto_preload?
+        true
+      end
+
       protected
 
       def association_needs_preload?(_association_name)

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)
@@ -28,6 +31,10 @@ module ArLazyPreload
         perform_preloading(association_name)
       end
 
+      def auto_preload?
+        false
+      end
+
       protected
 
       def association_needs_preload?(_association_name)
@@ -37,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
+        preloader.preload(filtered_records, association_name)
+
         loaded_association_names.add(association_name)
 
         AssociatedContextBuilder.prepare(
@@ -57,6 +68,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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:
     - - ">="