ar_lazy_preload 0.3.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8f6aa06d7f037bd8762f0000db03adde926f41ee536ec4faac8b1f3ca93ff1e
-  data.tar.gz: c6a8b59093090fc898692c102acda5ed949a34846605b65a6f27b89b940d2d46
+  metadata.gz: f8b1ef234e5a995bfce176e47fe5526fba9330b61cc27374e6667a5f5dfca3af
+  data.tar.gz: 3516b8bf449802b2ba3ff7022faec299ff274fe4716db884e46da63fe47d5ac9
 SHA512:
-  metadata.gz: 41abf78b2668b8f39c5713a72a6536a57f660bea16bdebdb4a2f1d069c86285d0455c2d193d46f2dbe12551e12d823c1187163223193826d3861154f67c03c1d
-  data.tar.gz: 7cd15b8bf27071baa258992e99a726e9b49f25ea5d8edb2802fa9d2e30ce652bb204acfb131b8e0adff33f178a6a1d322e4717e2f8339da4224765a5da92ca30
+  metadata.gz: 80a0a1e05b961a6d66b20c0b5e1a32ee2824d868e7e96d25e85b4e2b3c48baa1ee9129cf934b71e73a2887245faa9f54b3ecc23cc7815d60c30efc8bca9fbb7b
+  data.tar.gz: bbb5f854ed701c562d31f00cf3f832eb668c42aca809e4376aed4b78c114bd3c25db15edea712d65419a23c3fbbe1dfac5d698055dad5c5ae61ea837ea6fa273

data/README.md

@@ -44,6 +44,22 @@ ArLazyPreload.config.auto_preload = true
 
 After that there is no need to call `#lazy_preload` on the association, everything would be loaded lazily.
 
+If you want to turn automatic preload off for a specific record, you can call `.skip_preload` before any associations method:
+
+```ruby
+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 (...)
+```
+
 ## 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,10 +5,17 @@ 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
 
     delegate :try_preload_lazily, to: :lazy_preload_context, allow_nil: true
+
+    def skip_preload
+      lazy_preload_context&.records&.delete(self)
+      self.lazy_preload_context = nil
+      self
+    end
   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.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.2
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: db-query-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models