ar_lazy_preload 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18865f27f303c041869d4cbeb759d90adde8f2255b970d0752d789b0604f3846
-  data.tar.gz: f6818b6e38baf72a2bd8881c6727a70fc01a4c90916ed888cf0e51c837858851
+  metadata.gz: 0f5333ce93f4dabe64d5f71e9c838c883a7a40f859cec39b80eb60b60f7e0dea
+  data.tar.gz: 7795be2e1dc2f6661deeb3b5a014de62b927004c40911ee6dab0299d493efd56
 SHA512:
-  metadata.gz: 81e6e8d0dc2ced79052f0b05018a87353abbf416ee234ff6f00c98fa22912a08b4161bece20f78187d25c9221a13ba2f4bea7450916f4f32900e0c60dac99d6e
-  data.tar.gz: 5f970163332f177b5dbfbbe000fbbca4174bfe822d512ceb3bfa2263a769dfd438d39d7faf2cc516f7d05a7cfb1bd5b2bf1377ec7592312b9a6f7f75e92602fa
+  metadata.gz: 4a96f77158652b6cd1923c6e48f7f068f0d12950ad918718229b0bb2763c4c90183a6dadfdcff043be84a5eb06129efa199530648c009c326f0415616658b7d6
+  data.tar.gz: e3aadc85c581e91a17642547e2527f0b210e4a899f2bb0be2d77c2589fd9016fe811910af53232bf222bf223312261b38a6a1d7b29ff9e85a8efd94b8e49990c

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/merger.rb

@@ -8,7 +8,7 @@ module ArLazyPreload
     def merge
       result = super
 
-      if other.lazy_preload_values
+      if other.lazy_preload_values.any?
         if other.klass == relation.klass
           merge_lazy_preloads
         else

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,6 +23,7 @@ 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?
@@ -32,14 +33,19 @@ module ArLazyPreload
         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)

data/lib/ar_lazy_preload/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-08-28 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