ar_lazy_preload 0.7.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780b04da1bdc2de0822bcf78d9ac51d7e24f5bf66aee70d42e81a0a0cb662a21
-  data.tar.gz: bceb49a3525fcfcac85d8662485992bc81e37015a9100a4332f3aaae1c0bd59e
+  metadata.gz: c318927cb52d775d3a85e91fb24b7102e9fcb8004ced72fc1482ec0c7c4d1269
+  data.tar.gz: 8ceb003e63266df93da708925b261fab06334758366ce68b361609c2dbd07682
 SHA512:
-  metadata.gz: d32ee8fe923b29451f032ebb050168d6eaec8d5aec0b3136917a8196284198323ed804061bf64c7b36e104b95a43ced12372baa39a79976a1f69ae22a44c190c
-  data.tar.gz: d104a956772f064cb255db1f6743edd312da87da0526d2eff669976ce6f8537fb78a49cb302fa818942a4bb2bf1f0f0ae4226053c696e4575981aef774c356a9
+  metadata.gz: 9d52b4b8293a9e0c2eaa47bf21b603d1066d7b18b738e724a3b16b20188a56326bd4a52d9397481ef81fcbec368e1929ff4679fe7cfb47ba3d704421eda2ad83
+  data.tar.gz: 716b102784e7c22119320d7cc5ae513dcb8f2097eb5dba31e50fbbe64940f96324eff7ed2410eea6171a899880b4fc81683d2b43233607ea12740693b8358b69

data/README.md

@@ -1,18 +1,12 @@
-# ArLazyPreload [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/activerecord-lazy-preload.html) [![Gem Version](https://badge.fury.io/rb/ar_lazy_preload.svg)](https://rubygems.org/gems/ar_lazy_preload) [![Build Status](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload.svg?branch=master)](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload) [![Maintainability](https://api.codeclimate.com/v1/badges/00d04595661820dfba80/maintainability)](https://codeclimate.com/github/DmitryTsepelev/ar_lazy_preload/maintainability) [![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/ar_lazy_preload/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/ar_lazy_preload?branch=master)
+# ArLazyPreload [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/activerecord-lazy-preload.html) [![Gem Version](https://badge.fury.io/rb/ar_lazy_preload.svg)](https://rubygems.org/gems/ar_lazy_preload) [![Build Status](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/rspec.yml/badge.svg)](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/rspec.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/00d04595661820dfba80/maintainability)](https://codeclimate.com/github/DmitryTsepelev/ar_lazy_preload/maintainability) [![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/ar_lazy_preload/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/ar_lazy_preload?branch=master) ![](https://ruby-gem-downloads-badge.herokuapp.com/ar_lazy_preload?type=total)
 
 **ArLazyPreload** is a gem that brings association lazy load functionality to your Rails applications. There is a number of built-in methods to solve [N+1 problem](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations), but sometimes a list of associations to preload is not obvious–this is when you can get most of this gem.
 
 - **Simple**. The only thing you need to change is to use `#lazy_preload` instead of `#includes`, `#eager_load` or `#preload`
-- **Fast**. Take a look at [benchmarks](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload) (`TASK=bench` and `TASK=memory`)
+- **Fast**. Take a look at [performance benchmark](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/bench.yml) and [memory benchmark](https://github.com/DmitryTsepelev/ar_lazy_preload/actions/workflows/memory.yml)
 - **Perfect fit for GraphQL**. Define a list of associations to load at the top-level resolver and let the gem do its job
 - **Auto-preload support**. If you don't want to specify the association list–set `ArLazyPreload.config.auto_preload` to `true`
 
-<p align="center">
-  <a href="https://evilmartians.com/?utm_source=ar_lazy_preload">
-    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-  </a>
-</p>
-
 ## Why should I use it?
 
 Lazy loading is super helpful when the list of associations to load is determined dynamically. For instance, in GraphQL this list comes from the API client, and you'll have to inspect the selection set to find out what associations are going to be used.
@@ -50,6 +44,8 @@ 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 = ?
 ```
 
+> *Warning* : Using the `ArLazyPreload.config.auto_preload` feature makes ArLazyPreload try to preload *every* association target throughout your app, and in any other gem that makes association target calls. When enabling the setting in an existing app, you may find some edge cases where previous working queries now fail, and you should test most of your app paths to ensure that there are no such issues.
+
 ### Relation auto preloading
 
 Another alternative for auto preloading is using relation `#preload_associations_lazily` method
@@ -81,6 +77,10 @@ Add this line to your application's Gemfile, and you're all set:
 gem "ar_lazy_preload"
 ```
 
+## Credits
+
+Initially sponsored by [Evil Martians](http://evilmartians.com).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ar_lazy_preload/active_record/base.rb

@@ -6,16 +6,27 @@ module ArLazyPreload
     def self.included(base)
       base.class.delegate :lazy_preload, to: :all
       base.class.delegate :preload_associations_lazily, to: :all
+      base.after_create { try_setup_auto_preload_context }
     end
 
     attr_accessor :lazy_preload_context
 
     delegate :try_preload_lazily, to: :lazy_preload_context, allow_nil: true
 
+    def reload
+      super.tap { try_setup_auto_preload_context }
+    end
+
     def skip_preload
       lazy_preload_context&.records&.delete(self)
       self.lazy_preload_context = nil
       self
     end
+
+    private
+
+    def try_setup_auto_preload_context
+      ArLazyPreload::Context.register(records: [self]) if ArLazyPreload.config.auto_preload?
+    end
   end
 end

data/lib/ar_lazy_preload/active_record/relation.rb

@@ -12,11 +12,9 @@ module ArLazyPreload
     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|
+        ArLazyPreload::Preloader.new(records, associations).preload.each do |preloader_association|
           handle_preloaded_records(preloader_association.preloaded_records)
         end
       end

data/lib/ar_lazy_preload/context.rb

@@ -8,7 +8,7 @@ require "ar_lazy_preload/contexts/temporary_preload_config"
 module ArLazyPreload
   class Context
     # Initiates lazy preload context for given records
-    def self.register(records:, association_tree:, auto_preload: false)
+    def self.register(records:, association_tree: nil, auto_preload: false)
       return if records.empty?
 
       if ArLazyPreload.config.auto_preload? || auto_preload

data/lib/ar_lazy_preload/contexts/base_context.rb

@@ -2,6 +2,7 @@
 
 require "set"
 require "ar_lazy_preload/associated_context_builder"
+require "ar_lazy_preload/preloader"
 
 module ArLazyPreload
   module Contexts
@@ -63,7 +64,7 @@ module ArLazyPreload
       # help of the TemporaryPreloadConfig
       def preload_records(association_name, records)
         TemporaryPreloadConfig.within_context do
-          preloader.preload(records, association_name)
+          ArLazyPreload::Preloader.new(records, [association_name]).preload
         end
       end
 
@@ -75,10 +76,6 @@ module ArLazyPreload
         @loaded_association_names ||= Set.new
       end
 
-      def preloader
-        @preloader ||= ActiveRecord::Associations::Preloader.new
-      end
-
       def preloadable_record?(association_name, record)
         preloadable_reflections_cache.dig(record.class, association_name)
       end

data/lib/ar_lazy_preload/preloader.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  class Preloader
+    def initialize(records, associations)
+      @records = records
+      @associations = associations
+    end
+
+    class << self
+      def patch_for_rails_7!
+        define_method(:preload) do
+          ActiveRecord::Associations::Preloader.new(
+            records: @records, associations: @associations
+          ).call
+        end
+      end
+    end
+
+    def preload
+      ActiveRecord::Associations::Preloader.new.preload(@records, @associations)
+    end
+  end
+end

data/lib/ar_lazy_preload/railtie.rb

@@ -25,6 +25,8 @@ module ArLazyPreload
 
         ActiveRecord::Associations::CollectionAssociation.prepend(CollectionAssociation)
         ActiveRecord::Associations::CollectionProxy.prepend(CollectionProxy)
+
+        ArLazyPreload::Preloader.patch_for_rails_7! if ActiveRecord::VERSION::MAJOR >= 7
       end
     end
   end

data/lib/ar_lazy_preload/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.1.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -205,13 +205,14 @@ files:
 - 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/preloader.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
@@ -219,15 +220,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: lazy_preload implementation for ActiveRecord models
 test_files: []