n1_loader 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56479004f7a3456664bac05e808268177dabffa616848b57efb734865fd5ec49
-  data.tar.gz: 2d65c334abe26c5eb9baeb17ebe186d201b6c362b60d628758defd696b3e3522
+  metadata.gz: 993f807b671a08f82ed5ad7eff20cae7ab4d8e910772ba944543f8a46343c313
+  data.tar.gz: d0489f877243e19caf4c5b8fab6083dbe283aad6e89199386d611745840065ce
 SHA512:
-  metadata.gz: 9d83a5cc7742f23b0702f56fbcd2320f46e309731c7734df825406a657709259dae08e2e3ed78db322f815438e5e0db82cbe40799e02bb7d0f7cd469ad453585
-  data.tar.gz: 225fa5c982e60ceaae8d5a8cbd90ff6ecd8d54cff5105bc1338d45e6fb9969586af5ced3fa6b3a7c6948a453ee7bd7956a30f2972527719d32467116da48f7ce
+  metadata.gz: f47c6eb0400062948a5bb9c19cbb71b56cc10615773f5dd031fcc138485303ddbd3bb9b9f0070afc5f5baaaebd917c8da0f2c00dd93a29956bcdfca9d6581a73
+  data.tar.gz: 7cbcf9de6b8b20b0e2d100d79f787343f542200da3ec234d0f13ef6353ca0bbf3e05afd06584528d70701ff08bfd461d63c9c83625164f9579123417a092a406

data/lib/n1_loader/active_record/loader.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 N1Loader::Loader.define_method :preloaded_records do
-  @preloaded_records ||= loaded.values.flatten
+  @preloaded_records ||= loaded? && loaded_by_value.values.flatten
 end

data/lib/n1_loader/ar_lazy_preload/loader_patch.rb

@@ -6,17 +6,22 @@ module N1Loader
     module LoaderPatch
       attr_accessor :context_setup
 
-      def loaded
-        return @loaded_by_identity if @already_loaded && @already_context
+      def loaded?
+        return true if @already_loaded && @already_context
 
         super
 
-        synchronize do
-          context_setup&.call(@loaded_by_identity.values.flatten) unless @already_context
-        end
+        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
-        @loaded_by_identity
       end
     end
   end

data/lib/n1_loader/core/loadable.rb

@@ -33,9 +33,21 @@ module N1Loader
     end
 
     def n1_bind_to(collection)
+      unless collection.is_a?(Array) && collection.any? do |obj|
+        obj == self || obj.equal?(self)
+      end
+
+        raise InvalidBinding,
+              "assigned collection should be array and include object"
+      end
+
       @n1_binding = collection
     end
 
+    def n1_bind_to?
+      !@n1_binding.nil?
+    end
+
     def n1_loader_reload(name)
       elements = @n1_binding || [self]
       collection = LoaderCollection.new(self.class.n1_loaders[name], elements)

data/lib/n1_loader/core/loader.rb

@@ -47,14 +47,14 @@ module N1Loader
     end
 
     def for(element)
-      identity_loaded = loaded
+      return unless loaded?
 
-      if identity_loaded.empty? && elements.any?
+      if loaded_by_identity.empty? && elements.any?
         raise NotFilled, "Nothing was preloaded, perhaps you forgot to use fulfill method"
       end
 
-      return identity_loaded[element] if identity_loaded.key?(element)
-      return @loaded_by_value[element] if @loaded_by_value.key?(element)
+      return loaded_by_identity[element] if loaded_by_identity.key?(element)
+      return loaded_by_value[element] if loaded_by_value.key?(element)
 
       raise NotLoaded, "The data was not preloaded for the given element"
     end
@@ -66,7 +66,7 @@ module N1Loader
 
     private
 
-    attr_reader :elements, :args
+    attr_reader :elements, :args, :loaded_by_value, :loaded_by_identity
 
     def check_missing_arguments!
       return unless (arguments = self.class.arguments)
@@ -107,22 +107,19 @@ module N1Loader
     end
 
     def fulfill(element, value)
-      @loaded_by_identity[element] = value
-      @loaded_by_value[element] = value
+      loaded_by_identity[element] = value
+      loaded_by_value[element] = value
     end
 
-    def ensure_loaded
-      return if @already_loaded
+    def loaded?
+      return true if @already_loaded
 
-      synchronize { non_thread_safe_loaded unless @already_loaded }
-    end
+      synchronize { non_thread_safe_loading unless @already_loaded }
 
-    def loaded
-      ensure_loaded
-      @loaded_by_identity
+      true
     end
 
-    def non_thread_safe_loaded # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def non_thread_safe_loading # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       return if @already_loaded
 
       check_arguments!
@@ -133,8 +130,13 @@ module N1Loader
       if respond_to?(:single) && elements.size == 1
         fulfill(elements.first, single(elements.first))
       elsif elements.any?
-        elements.each { |el| el.n1_bind_to(elements) if el.respond_to?(:n1_bind_to) }
         perform(elements)
+
+        # propagate context to loaded objects only when it was set
+        if elements.first.respond_to?(:n1_bind_to?) && elements.first.n1_bind_to?
+          loaded_objects = loaded_by_identity.values.flatten
+          loaded_objects.each { |el| el.n1_bind_to(loaded_objects) if el.respond_to?(:n1_bind_to) }
+        end
       end
 
       @already_loaded = true

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.0"
+  VERSION = "3.0.0"
 end

data/lib/n1_loader.rb

@@ -15,4 +15,5 @@ module N1Loader # :nodoc:
   class NotFilled < Error; end
   class MissingArgument < Error; end
   class InvalidArgument < Error; end
+  class InvalidBinding < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 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: