n1_loader 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24b29bd98ee754ae976c84c253a4d9018cc3372003a6965d1227d578f9cd6d4d
-  data.tar.gz: 39ccc3e7314dd901cd47c2dd15d16154fefa5529a33e269e7e42877e78d3f7fa
+  metadata.gz: 993f807b671a08f82ed5ad7eff20cae7ab4d8e910772ba944543f8a46343c313
+  data.tar.gz: d0489f877243e19caf4c5b8fab6083dbe283aad6e89199386d611745840065ce
 SHA512:
-  metadata.gz: 1ff08212965c0d67d3035be2e083ba6240fc1d034880d29615d88d7c88bbf7c3b61057779ff88c22d27a501d59098a4b67b5a406ff2e2e3984a72c5de6d33459
-  data.tar.gz: da51833d93a6109edb7eb284e024b3f24c8684e4765166ba55b4a4279dd2ea23c905e0f37762cef007adef12efbb3d8a46c52030ff3b047e38b18798b7579c2f
+  metadata.gz: f47c6eb0400062948a5bb9c19cbb71b56cc10615773f5dd031fcc138485303ddbd3bb9b9f0070afc5f5baaaebd917c8da0f2c00dd93a29956bcdfca9d6581a73
+  data.tar.gz: 7cbcf9de6b8b20b0e2d100d79f787343f542200da3ec234d0f13ef6353ca0bbf3e05afd06584528d70701ff08bfd461d63c9c83625164f9579123417a092a406

data/lib/n1_loader/goldiloader/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.
+Goldiloader::AutoIncludeContext.define_method :fetch_n1_loader_collection do |loader, &block|
+  (@n1_loader_collections ||= {})[loader] ||= block.call
+end

data/lib/n1_loader/goldiloader/context_adapter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module N1Loader
+  module Goldiloader
+    # Context adapter for injected N1Loader loaders.
+    class ContextAdapter
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+      end
+
+      # Trigger preloading for +association_name+ across all models in the context.
+      def try_preload_lazily(association_name)
+        perform_preloading(association_name) if context
+      end
+
+      # Initialize preloader for +association_name+ with context builder callback.
+      # The callback will be executed when records are loaded.
+      def perform_preloading(association_name)
+        context_setup = lambda { |records|
+          ar_records = records.flatten(1).select { |record| record.respond_to?(:auto_include_context=) }
+          ::Goldiloader::AutoIncludeContext.register_models(ar_records) unless ar_records.empty?
+        }
+
+        N1Loader::Preloader.new(context.models, context_setup).preload(association_name)
+      end
+    end
+  end
+end

data/lib/n1_loader/goldiloader/loadable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module N1Loader
+  module Goldiloader
+    module Loadable # :nodoc:
+      def n1_loader(name)
+        return n1_loaders[name] if n1_loaders[name]
+
+        ContextAdapter.new(auto_include_context).try_preload_lazily(name) if respond_to?(:auto_include_context)
+
+        super
+      end
+    end
+  end
+end

data/lib/n1_loader/goldiloader/loader.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Raised when a single object without Goldiloader context support was passed to an isolated loader.
+N1Loader::Loader::UnsupportedGoldiloader = Class.new(StandardError)
+
+# Defines a singleton method that allows isolated loaders
+# to use Goldiloader context without passing sibling records.
+N1Loader::Loader.define_singleton_method(:for) do |element, **args|
+  # It is required to have a Goldiloader context supported
+  raise N1Loader::Loader::UnsupportedGoldiloader unless element.respond_to?(:auto_include_context)
+
+  context = element.auto_include_context
+
+  # Fetch or initialize loader from Goldiloader context
+  loader_collection = context.fetch_n1_loader_collection(self) do
+    context_setup = lambda { |records|
+      ar_records = records.flatten(1).select { |record| record.respond_to?(:auto_include_context=) }
+      ::Goldiloader::AutoIncludeContext.register_models(ar_records) unless ar_records.empty?
+    }
+
+    N1Loader::LoaderCollection.new(self, context.models).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/goldiloader/loader_collection_patch.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module N1Loader
+  module Goldiloader
+    # A patch to {N1Loader::LoaderCollection} to setup lazy context lazily.
+    module LoaderCollectionPatch
+      attr_accessor :context_setup
+
+      def with(**args)
+        result = super
+
+        result.context_setup = context_setup if context_setup && result.context_setup.nil?
+
+        result
+      end
+    end
+  end
+end

data/lib/n1_loader/goldiloader/loader_patch.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module N1Loader
+  module Goldiloader
+    # A patch to {N1Loader::Loader} to setup lazy context lazily.
+    module LoaderPatch
+      attr_accessor :context_setup
+
+      def loaded?
+        return true if @already_loaded && @already_context
+
+        super
+
+        synchronize { non_thread_safe_context_setting unless @already_context }
+
+        true
+      end
+
+      def non_thread_safe_context_setting
+        return if @already_context
+
+        context_setup&.call(loaded_by_identity.values.flatten)
+
+        @already_context = true
+      end
+    end
+  end
+end

data/lib/n1_loader/goldiloader/preloader_patch.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module N1Loader
+  module Goldiloader
+    # A patch to {N1Loader::Preloader} to setup lazy context lazily.
+    module PreloaderPatch
+      def initialize(elements, context_setup = nil)
+        super(elements)
+        @context_setup = context_setup
+      end
+
+      def preload(*keys)
+        super.each do |loader_collection|
+          loader_collection.context_setup = context_setup
+        end
+      end
+
+      private
+
+      attr_reader :context_setup
+    end
+  end
+end

data/lib/n1_loader/goldiloader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Load core library
+require_relative "active_record"
+
+# Load integration dependency
+require "goldiloader"
+
+# Library integration
+require_relative "goldiloader/loadable"
+require_relative "goldiloader/context_adapter"
+require_relative "goldiloader/loader_collection_patch"
+require_relative "goldiloader/preloader_patch"
+require_relative "goldiloader/loader_patch"
+require_relative "goldiloader/loader"
+require_relative "goldiloader/context"
+
+N1Loader::Loadable.prepend(N1Loader::Goldiloader::Loadable)
+N1Loader::Preloader.prepend(N1Loader::Goldiloader::PreloaderPatch)
+N1Loader::Loader.prepend(N1Loader::Goldiloader::LoaderPatch)
+N1Loader::LoaderCollection.prepend(N1Loader::Goldiloader::LoaderCollectionPatch)

data/lib/n1_loader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-17 00:00:00.000000000 Z
+date: 2026-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mutex_m
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: goldiloader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +193,14 @@ files:
 - lib/n1_loader/core/loader_builder.rb
 - lib/n1_loader/core/loader_collection.rb
 - lib/n1_loader/core/preloader.rb
+- lib/n1_loader/goldiloader.rb
+- lib/n1_loader/goldiloader/context.rb
+- lib/n1_loader/goldiloader/context_adapter.rb
+- lib/n1_loader/goldiloader/loadable.rb
+- lib/n1_loader/goldiloader/loader.rb
+- lib/n1_loader/goldiloader/loader_collection_patch.rb
+- lib/n1_loader/goldiloader/loader_patch.rb
+- lib/n1_loader/goldiloader/preloader_patch.rb
 - lib/n1_loader/version.rb
 homepage: https://github.com/djezzzl/n1_loader
 licenses: