ar_lazy_preload 0.2.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0790a19fd33c7b141ba62725951c084f84cd0d1e8678e807081dac6d1b9c4c
-  data.tar.gz: 714b3e6785f5ad4dd7278be3549638ec8ab2447cad82cc3f9a5cd53694d23006
+  metadata.gz: 122262e10bed3d8a2793e62f24ee39e7a01453933c68d8faffce8945b794a522
+  data.tar.gz: e50652dd855cbbbe39b292b20e07fca7f43ba660fd2f28f0c41de1fa0595c281
 SHA512:
-  metadata.gz: e3f9bfdd8dec8fb021f96ad79b686248e15dc30e23585a3c7e386033c72ec8864d75de8c8a21c4c0ef00e57e63e61c7bd147a6554d5e634f6282959f11bade82
-  data.tar.gz: d9537e25cc267fdc4278f2ae467945482abb78e2716d823c915ce2c5d82c7190ed9713ab8ad2cf5f219eceb4b72954c9eb25854b5b593e3c9726d0dcef50b8cb
+  metadata.gz: 97a5044a80f021ea4f4c0bd0b27b0881858371bb60051014f885c791570346bafae8c2e4110f5f492817cbe38d44c551a4045d886a67e1ede30a5af5079afdac
+  data.tar.gz: '0458891f44c12464f6ce33295c6ef4e20bf55df63dc81a46ad840401cb47f1a782c466ee87f4c44c965b5090bc1c02ed2bead8a90f9b5031f9665803ade8e0a6'

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  # ActiveRecord::CollectionAssociation patch with a hook for lazy preloading
+  module CollectionAssociation
+    # rubocop:disable Metrics/AbcSize
+    def ids_reader
+      return super if owner.lazy_preload_context.blank?
+
+      primary_key = reflection.association_primary_key.to_sym
+      if loaded?
+        target.map(&primary_key)
+      elsif !target.empty?
+        load_target.map(&primary_key)
+      else
+        @association_ids ||= reader.map(&primary_key)
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+  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

@@ -15,6 +15,7 @@ module ArLazyPreload
       def initialize(records:)
         @records = records.dup
         @records.compact!
+        @records.uniq!
         @records.each { |record| record.lazy_preload_context = self }
       end
 
@@ -27,6 +28,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/railtie.rb

@@ -3,6 +3,7 @@
 require "ar_lazy_preload/active_record/base"
 require "ar_lazy_preload/active_record/relation"
 require "ar_lazy_preload/active_record/association"
+require "ar_lazy_preload/active_record/collection_association"
 require "ar_lazy_preload/active_record/merger"
 require "ar_lazy_preload/active_record/association_relation"
 require "ar_lazy_preload/active_record/collection_proxy"
@@ -22,6 +23,7 @@ module ArLazyPreload
           ActiveRecord::Associations::Association
         ].each { |klass| klass.prepend(Association) }
 
+        ActiveRecord::Associations::CollectionAssociation.prepend(CollectionAssociation)
         ActiveRecord::Associations::CollectionProxy.prepend(CollectionProxy)
       end
     end

data/lib/ar_lazy_preload/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.5.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-08-27 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
@@ -164,6 +164,7 @@ files:
 - lib/ar_lazy_preload/active_record/association.rb
 - lib/ar_lazy_preload/active_record/association_relation.rb
 - lib/ar_lazy_preload/active_record/base.rb
+- lib/ar_lazy_preload/active_record/collection_association.rb
 - lib/ar_lazy_preload/active_record/collection_proxy.rb
 - lib/ar_lazy_preload/active_record/merger.rb
 - lib/ar_lazy_preload/active_record/relation.rb
@@ -195,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