n1_loader 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef4b4cb71bedafe0820631695d26d1782f11d940899c8cdd2f745179197e489
-  data.tar.gz: 909035eceab471c23057fc075a719f22ab8d2138c114c92500153cc19178f8c0
+  metadata.gz: 3d914dd09225515a579945ab616916bf1ad446101c5051c4cf1b72c46d38c107
+  data.tar.gz: a304c32e35294c5646fafe5c65a5de6c637e80e080d80ac16f957d77a3ebe4c6
 SHA512:
-  metadata.gz: 5a47920e7df24aefbd413b8c2f2fdd6fd4e5918481109b8b79af01070d9c0f262784df0410ad6e758753405acaa7ffcc6a9dd2fc22eeab51cd5377885473b842
-  data.tar.gz: 8139a30fc4b15740c403aeee3791e56a4268d1890d0cb4aedd4d9d29e9b54c26a1e98541b2865932a005abf7d854b7461c0de4c3322beb7e08124f97fb75a11c
+  metadata.gz: 738d8ca021bca48a41486689c74506af32dc2bca8a542398272edaa72aa57dd49247249d04afe8d9b834cc28cd9b725f0a9b1d8d7f5dd80176cfd3c9ca711f08
+  data.tar.gz: c73ddc81593e0cbd0450457143726b9d57fbce0a27c09ede70ea3f269816b7ae7374e5dc1c06dda4e8b0ee8c21a0c96248ed4afb9e3d7f26ec5b5ac46e038d16

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+name: Rubocop
+
+on:
+  - pull_request
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.github/workflows/tests.yml

@@ -0,0 +1,62 @@
+name: RSpec tests
+
+on:
+  - pull_request
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - 'head'
+        activerecord-gemfile:
+          - 'ar_5_latest'
+          - 'ar_6_latest'
+          - 'ar_7_latest'
+        ar_lazy_preload-gemfile:
+          - 'ar_lazy_preload_0.6.1'
+          - 'ar_lazy_preload_master'
+        exclude:
+          - ruby-version: 'head'
+            activerecord-gemfile: 'ar_5_latest'
+
+          - ruby-version: 'head'
+            activerecord-gemfile: 'ar_5_latest'
+
+          - ruby-version: '3.0'
+            activerecord-gemfile: 'ar_5_latest'
+
+          - ruby-version: '3.0'
+            activerecord-gemfile: 'ar_5_latest'
+
+          - activerecord-gemfile: 'ar_7_latest'
+            ar_lazy_preload-gemfile: 'ar_lazy_preload_0.6.1'
+
+    env:
+      ACTIVERECORD_GEMFILE: ${{ matrix.activerecord-gemfile }}
+      AR_LAZY_PRELOAD_GEMFILE: ${{ matrix.ar_lazy_preload-gemfile }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run Core tests
+        run: bundle exec rspec spec/n1_loader_spec.rb
+
+      - name: Run ActiveRecord tests
+        run: bundle exec rspec spec/n1_loader_spec.rb spec/activerecord_spec.rb
+
+      - name: Run ArLazyPreload tests
+        run: bundle exec rspec spec/n1_loader_spec.rb spec/activerecord_spec.rb spec/ar_lazy_preload_spec.rb

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - examples/**/*
+    - vendor/bundle/**/*
 
 Style/StringLiterals:
   Enabled: true
@@ -16,4 +17,4 @@ Layout/LineLength:
 
 Metrics/BlockLength:
   Exclude:
-    - spec/**/*
+    - spec/**/*

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.6.0] - 2022/10/24
+
+- Add support of ArLazyPreload context for isolated loaders.
+
 ## [1.5.1] - 2022/09/20
 
 - Fix support of falsey value of arguments. Thanks [Aitor Lopez Beltran](https://github.com/aitorlb) for the [contribution](https://github.com/djezzzl/n1_loader/pull/23)!

data/README.md

@@ -149,6 +149,17 @@ p User.all.includes(:payments_total).map { |user| user.payments_total(from: from
 - Has [integration](examples/active_record_integration.rb) with [ActiveRecord][5] which makes it brilliant
 - Has [integration](examples/ar_lazy_integration.rb) with [ArLazyPreload][6] which makes it excellent
 
+### Feature killer for [ArLazyPreload][6] integration with isolated loaders
+
+In [version 1.6.0](CHANGELOG.md#160---20221019) isolated loaders were integrated with [ArLazyPreload][6] context.
+This means, it isn't required to inject `N1Loader` into your [ActiveRecord][5] models to avoid N+1 issues out of the box.
+It is especially great as many engineers are trying to avoid extra coupling between their models/services when it's possible.
+And this feature was designed exactly for this without losing an out of a box solution for N+1.
+
+Without further ado, please have a look at the [example](examples/ar_lazy_integration_with_isolated_loader.rb).
+
+_Spoiler:_ as soon as you have your loader defined, it will be as simple as `Loader.for(element)` to get your data efficiently and without N+1.
+
 ## Funding
 
 ### Open Collective Backers

data/examples/ar_lazy_integration.rb

@@ -29,9 +29,8 @@ fill_database
 # Has N+1
 p User.all.map { |user| user.payments.sum(&:amount) }
 
-# Has no N+1 but we load too many data that we don't need
+# Has no N+1 and loads only required data
 p User.preload_associations_lazily.map(&:payments_total)
-
-# Has no N+1 and calculation is the most efficient
+# or
 ArLazyPreload.config.auto_preload = true
-User.all.map(&:payments_total)
+User.all.map(&:payments_total)

data/examples/ar_lazy_integration_with_isolated_loader.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "n1_loader/ar_lazy_preload"
+
+require_relative 'context/setup_ar_lazy'
+require_relative 'context/setup_database'
+
+class Loader < N1Loader::Loader
+  def perform(users)
+    total_per_user = Payment.group(:user_id).where(user: users).sum(:amount).tap { |h| h.default = 0 }
+
+    users.each do |user|
+      total = total_per_user[user.id]
+      fulfill(user, total)
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :payments
+end
+
+class Payment < ActiveRecord::Base
+  belongs_to :user
+
+  validates :amount, presence: true
+end
+
+fill_database
+
+# Has N+1 and loads redundant data
+p User.all.map { |user| user.payments.sum(&:amount) }
+
+# Has no N+1 and loads only required data
+p User.preload_associations_lazily.all.map { |user| Loader.for(user) }
+
+# or
+ArLazyPreload.config.auto_preload = true
+p User.all.map { |user| Loader.for(user) }

data/lib/n1_loader/ar_lazy_preload/context.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Returns cached N1Loader::LoaderCollection from context for a loader.
+# In case there is none yet, saves passed block to a cache.
+ArLazyPreload::Contexts::BaseContext.define_method :fetch_n1_loader_collection do |loader, &block|
+  (@n1_loader_collections ||= {})[loader] ||= block.call
+end

data/lib/n1_loader/ar_lazy_preload/context_adapter.rb

@@ -2,7 +2,7 @@
 
 module N1Loader
   module ArLazyPreload
-    # Context adapter for N1Loader
+    # Context adapter for injected N1Loader loaders.
     class ContextAdapter
       attr_reader :context
 
@@ -12,12 +12,15 @@ module N1Loader
         @context = context
       end
 
+      # Assign initialized preloader to +association_name+ in case it wasn't yet preloaded within the given context.
       def try_preload_lazily(association_name)
         return unless context&.send(:association_needs_preload?, association_name)
 
         perform_preloading(association_name)
       end
 
+      # Initialize preloader for +association_name+ with context builder callback.
+      # The callback will be executed when on records load.
       def perform_preloading(association_name)
         context_setup = lambda { |records|
           AssociatedContextBuilder.prepare(

data/lib/n1_loader/ar_lazy_preload/loader.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Raised when a single object without ArLazyPreload context was passed to an isolated loader.
+N1Loader::Loader::MissingArLazyPreloadContext = Class.new(StandardError)
+
+# Defines a singleton method method that allows isolated loaders
+# to use ArLazyPreload context without passing sibling records.
+N1Loader::Loader.define_singleton_method(:for) do |element, **args|
+  # It is required to have an ArLazyPreload context defined
+  if !element.respond_to?(:lazy_preload_context) || element.lazy_preload_context.nil?
+    raise N1Loader::Loader::MissingArLazyPreloadContext
+  end
+
+  # Fetch or initialize loader from ArLazyPreload context
+  loader_collection = element.lazy_preload_context.fetch_n1_loader_collection(self) do
+    context_setup = lambda { |records|
+      N1Loader::ArLazyPreload::AssociatedContextBuilder.prepare(
+        parent_context: element.lazy_preload_context,
+        association_name: "cached_n1_loader_collection_#{self}".downcase.to_sym,
+        records: records
+      )
+    }
+
+    N1Loader::LoaderCollection.new(self, element.lazy_preload_context.records).tap do |collection|
+      collection.context_setup = context_setup
+    end
+  end
+
+  # Fetch value from loader
+  loader_collection.with(**args).for(element)
+end

data/lib/n1_loader/ar_lazy_preload.rb

@@ -14,6 +14,8 @@ require_relative "ar_lazy_preload/associated_context_builder"
 require_relative "ar_lazy_preload/loader_collection_patch"
 require_relative "ar_lazy_preload/preloader_patch"
 require_relative "ar_lazy_preload/loader_patch"
+require_relative "ar_lazy_preload/loader"
+require_relative "ar_lazy_preload/context"
 
 N1Loader::Loadable::ClassMethods.prepend(N1Loader::ArLazyPreload::Loadable::ClassMethods)
 N1Loader::Preloader.prepend(N1Loader::ArLazyPreload::PreloaderPatch)

data/lib/n1_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module N1Loader
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -162,6 +164,7 @@ files:
 - bin/setup
 - examples/active_record_integration.rb
 - examples/ar_lazy_integration.rb
+- examples/ar_lazy_integration_with_isolated_loader.rb
 - examples/arguments_support.rb
 - examples/context/service.rb
 - examples/context/setup_ar_lazy.rb
@@ -184,8 +187,10 @@ files:
 - lib/n1_loader/active_record/loader_collection.rb
 - lib/n1_loader/ar_lazy_preload.rb
 - lib/n1_loader/ar_lazy_preload/associated_context_builder.rb
+- lib/n1_loader/ar_lazy_preload/context.rb
 - lib/n1_loader/ar_lazy_preload/context_adapter.rb
 - lib/n1_loader/ar_lazy_preload/loadable.rb
+- lib/n1_loader/ar_lazy_preload/loader.rb
 - lib/n1_loader/ar_lazy_preload/loader_collection_patch.rb
 - lib/n1_loader/ar_lazy_preload/loader_patch.rb
 - lib/n1_loader/ar_lazy_preload/preloader_patch.rb
@@ -217,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Loader to solve N+1 issue for good.