n1_loader 1.7.1 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35755dbc6a0ae17e636a26aaa99d903714a2e61248f60cc7a6c23f0d1ff5cbdd
-  data.tar.gz: 34ebd3c7c2d873fb42fce414c74055251ef6169df1a06ec6255a857598c8fdf7
+  metadata.gz: 69bd23d2b22a8c7fccab4ca436c23079961fe20d5eb9eb5c9d5f9d6e9cfe6ab2
+  data.tar.gz: 8c7d60b0cb94207339ea697dc977d9669a5af9931b745bce889257535aaed109
 SHA512:
-  metadata.gz: b4233a0b750ccfa3e001b512a379fb5a68758c45117fdaa0b5ec9cfd1c84d344c7e261ee61927794db2246aaa6c40b9576d5a19d1e547e65f6e08eab21de903d
-  data.tar.gz: ee26e611bf87f7daf78912f01996bd7330a0dbb0d74e18a38af79b7f4869b6c43365694ef5f8597a8f1574e5cb16ff1ca4bf73421019215b29f139e4917510e9
+  metadata.gz: 340851e05310b0cfb05c9b8acd412d4bb1d06747e61e311008bd217bfead1aef6cc123bd3ca333a6bca025d0a367b2b0b4f589899438455cd9702ac6d79012c8
+  data.tar.gz: bdf43c35be906b011170d053ed050a60b7491087e10afde229510a10293df1d64e32a2a04d8c304611ae8a417c05568f7deda51a91b81b68820390a47dd824e7

data/lib/n1_loader/active_record/associations_preloader_v5.rb

@@ -24,11 +24,11 @@ module N1Loader
 
         def grouped_records(association, records)
           n1_load_records, records = records.partition do |record|
-            record.class.respond_to?(:n1_loader_defined?) && record.class.n1_loader_defined?(association)
+            record.class.respond_to?(:n1_loaders) && record.class.n1_loaders.key?(association)
           end
 
           hash = n1_load_records.group_by do |record|
-            N1LoaderReflection.new(association, record.class.n1_loader(association))
+            N1LoaderReflection.new(association, record.class.n1_loaders[association])
           end
 
           hash.merge(super)

data/lib/n1_loader/active_record/associations_preloader_v6.rb

@@ -18,11 +18,11 @@ module N1Loader
 
         def grouped_records(association, records, polymorphic_parent)
           n1_load_records, records = records.partition do |record|
-            record.class.respond_to?(:n1_loader_defined?) && record.class.n1_loader_defined?(association)
+            record.class.respond_to?(:n1_loaders) && record.class.n1_loaders[association]
           end
 
           hash = n1_load_records.group_by do |record|
-            N1LoaderReflection.new(association, record.class.n1_loader(association))
+            N1LoaderReflection.new(association, record.class.n1_loaders[association])
           end
 
           hash.merge(super)

data/lib/n1_loader/active_record/associations_preloader_v7.rb

@@ -18,11 +18,11 @@ module N1Loader
 
         def grouped_records # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
           n1_load_records, records = source_records.partition do |record|
-            record.class.respond_to?(:n1_loader_defined?) && record.class.n1_loader_defined?(association)
+            record.class.respond_to?(:n1_loaders) && record.class.n1_loaders[association]
           end
 
           h = n1_load_records.group_by do |record|
-            N1LoaderReflection.new(association, record.class.n1_loader(association))
+            N1LoaderReflection.new(association, record.class.n1_loaders[association])
           end
 
           polymorphic_parent = !root? && parent.polymorphic?

data/lib/n1_loader/ar_lazy_preload/loadable.rb

@@ -2,22 +2,13 @@
 
 module N1Loader
   module ArLazyPreload
-    module Loadable
-      module ClassMethods # :nodoc:
-        def n1_optimized(name, loader = nil, &block)
-          name, loader_name, loader_variable_name = super
+    module Loadable # :nodoc:
+      def n1_loader(name)
+        return n1_loaders[name] if n1_loaders[name]
 
-          define_method(loader_name) do
-            loader = instance_variable_get(loader_variable_name)
-            return loader if loader
+        ContextAdapter.new(lazy_preload_context).try_preload_lazily(name) if respond_to?(:lazy_preload_context)
 
-            if respond_to?(:lazy_preload_context) && ContextAdapter.new(lazy_preload_context).try_preload_lazily(name)
-              return instance_variable_get(loader_variable_name)
-            end
-
-            send("#{loader_name}_reload")
-          end
-        end
+        super
       end
     end
   end

data/lib/n1_loader/ar_lazy_preload.rb

@@ -17,7 +17,7 @@ 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::Loadable.prepend(N1Loader::ArLazyPreload::Loadable)
 N1Loader::Preloader.prepend(N1Loader::ArLazyPreload::PreloaderPatch)
 N1Loader::Loader.prepend(N1Loader::ArLazyPreload::LoaderPatch)
 N1Loader::LoaderCollection.prepend(N1Loader::ArLazyPreload::LoaderCollectionPatch)

data/lib/n1_loader/core/loadable.rb

@@ -7,14 +7,14 @@ module N1Loader
   #     include N1Loader::Loadable
   #
   #     # with inline loader
-  #     n1_loader :something do
+  #     n1_optimized :something do
   #       def perform(elements)
   #         elements.each { |element| fulfill(element, element.calculate_something) }
   #       end
   #     end
   #
   #     # with custom loader
-  #     n1_loader :something, MyLoader
+  #     n1_optimized :something, MyLoader
   #   end
   #
   #   # custom loader
@@ -24,23 +24,21 @@ module N1Loader
   #     end
   #   end
   module Loadable
-    include Name
+    def n1_loaders
+      @n1_loaders ||= {}
+    end
 
     def n1_loader(name)
-      name = n1_loader_name(name)
-
-      send("#{name}_loader")
+      n1_loaders[name]
     end
 
-    def n1_loader_set(name, loader_collection)
-      name = n1_loader_name(name)
-
-      send("#{name}_loader=", loader_collection)
+    def n1_loader_reload(name)
+      n1_loaders[name] = LoaderCollection.new(self.class.n1_loaders[name], [self])
     end
 
     def n1_clear_cache
-      self.class.n1_loaders.each do |name|
-        n1_loader_set(name, nil)
+      self.class.n1_loaders.each_key do |name|
+        n1_loaders[name] = nil
       end
     end
 
@@ -49,61 +47,20 @@ module N1Loader
     end
 
     module ClassMethods # :nodoc:
-      include Name
-
-      def n1_loader(name)
-        name = n1_loader_name(name)
-
-        send("#{name}_loader")
-      end
-
-      def n1_loader_defined?(name)
-        name = n1_loader_name(name)
-
-        respond_to?("#{name}_loader")
-      end
-
       def n1_loaders
-        @n1_loaders ||= superclass.respond_to?(:n1_loaders) ? superclass.n1_loaders.dup : []
+        @n1_loaders ||= superclass.respond_to?(:n1_loaders) ? superclass.n1_loaders.dup : {}
       end
 
-      def n1_optimized(name, loader = nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        loader ||= Class.new(N1Loader::Loader) do
-          if block.arity == 1
-            define_method(:perform, &block)
-          else
-            class_eval(&block)
-          end
-        end
-        loader_name = "#{n1_loader_name(name)}_loader"
-        loader_variable_name = "@#{loader_name}"
-
-        n1_loaders << name
-
-        define_singleton_method(loader_name) do
-          loader
-        end
-
-        define_method("#{loader_name}_reload") do
-          instance_variable_set(loader_variable_name,
-                                N1Loader::LoaderCollection.new(self.class.send(loader_name), [self]))
-        end
+      def n1_optimized(name, loader = nil, &block)
+        loader ||= LoaderBuilder.build(&block)
 
-        define_method("#{loader_name}=") do |loader_collection_instance|
-          instance_variable_set(loader_variable_name, loader_collection_instance)
-        end
-
-        define_method(loader_name) do
-          instance_variable_get(loader_variable_name) || send("#{loader_name}_reload")
-        end
+        n1_loaders[name] = loader
 
         define_method(name) do |reload: false, **args|
-          send("#{loader_name}_reload") if reload
+          n1_loader_reload(name) if reload || n1_loader(name).nil?
 
-          send(loader_name).with(**args).for(self)
+          n1_loader(name).with(**args).for(self)
         end
-
-        [name, loader_name, loader_variable_name]
       end
     end
   end

data/lib/n1_loader/core/loader.rb

@@ -62,11 +62,10 @@ module N1Loader
 
     attr_reader :elements, :args
 
-    def check_missing_arguments! # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def check_missing_arguments!
       return unless (arguments = self.class.arguments)
 
-      required_arguments = arguments.reject { |argument| argument[:optional] }
-                                    .map { |argument| argument[:name] }
+      required_arguments = required_arguments(arguments)
 
       return if required_arguments.all? { |argument| args.key?(argument) }
 
@@ -74,8 +73,12 @@ module N1Loader
 
       list = missing_arguments.map { |argument| ":#{argument}" }.join(", ")
 
-      raise MissingArgument,
-            "Loader requires [#{list}] arguments but they are missing"
+      raise MissingArgument, "Loader requires [#{list}] arguments but they are missing"
+    end
+
+    def required_arguments(args)
+      args.reject { |argument| argument[:optional] }
+          .map { |argument| argument[:name] }
     end
 
     def check_arguments!

data/lib/n1_loader/core/loader_builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module N1Loader
+  # The class builds {N1Loader::Loader}
+  class LoaderBuilder
+    def self.build(&block)
+      Class.new(N1Loader::Loader) do
+        if block.arity == 1
+          define_method(:perform, &block)
+        else
+          class_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/n1_loader/core/preloader.rb

@@ -18,22 +18,19 @@ module N1Loader
       keys.flatten(1).flat_map do |key|
         elements
           .group_by { |element| loader_class(element, key) }
-          .map do |loader_class, grouped_elements|
-            next unless loader_class
-
+          .select { |loader_class, _| loader_class }
+          .map do |(loader_class, grouped_elements)|
             loader_collection = N1Loader::LoaderCollection.new(loader_class, grouped_elements)
-            grouped_elements.each { |grouped_element| grouped_element.n1_loader_set(key, loader_collection) }
+            grouped_elements.each { |grouped_element| grouped_element.n1_loaders[key] = loader_collection }
             loader_collection
-          end.compact
+          end
       end
     end
 
     private
 
     def loader_class(element, key)
-      element.class.respond_to?(:n1_loader_defined?) &&
-        element.class.n1_loader_defined?(key) &&
-        element.class.n1_loader(key)
+      element.class.respond_to?(:n1_loaders) && element.class.n1_loaders[key]
     end
   end
 end

data/lib/n1_loader/version.rb

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

data/lib/n1_loader.rb

@@ -2,7 +2,7 @@
 
 require_relative "n1_loader/version"
 
-require_relative "n1_loader/core/name"
+require_relative "n1_loader/core/loader_builder"
 require_relative "n1_loader/core/loader"
 require_relative "n1_loader/core/loader_collection"
 require_relative "n1_loader/core/loadable"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.3
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-30 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -143,39 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/tests.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- activerecord-gemfiles/ar_5_latest.gemfile
-- activerecord-gemfiles/ar_6_latest.gemfile
-- activerecord-gemfiles/ar_7_latest.gemfile
-- ar_lazy_preload-gemfiles/ar_lazy_preload_0.6.1.gemfile
-- ar_lazy_preload-gemfiles/ar_lazy_preload_master.gemfile
-- bin/console
-- 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
-- examples/context/setup_database.rb
-- examples/core.rb
-- examples/graphql.rb
-- examples/isolated_loader.rb
-- examples/lazy_loading.rb
-- examples/reloading.rb
-- examples/shared_loader.rb
-- examples/single_case.rb
-- guides/enhanced-activerecord.md
 - lib/n1_loader.rb
 - lib/n1_loader/active_record.rb
 - lib/n1_loader/active_record/associations_preloader_v5.rb
@@ -195,11 +162,10 @@ files:
 - lib/n1_loader/ar_lazy_preload/preloader_patch.rb
 - lib/n1_loader/core/loadable.rb
 - lib/n1_loader/core/loader.rb
+- lib/n1_loader/core/loader_builder.rb
 - lib/n1_loader/core/loader_collection.rb
-- lib/n1_loader/core/name.rb
 - lib/n1_loader/core/preloader.rb
 - lib/n1_loader/version.rb
-- n1_loader.gemspec
 homepage: https://github.com/djezzzl/n1_loader
 licenses:
 - MIT

data/.github/workflows/rubocop.yml

@@ -1,24 +0,0 @@
-name: Rubocop
-
-on:
-  pull_request:
-  schedule:
-    - cron: '0 0 * * 0'
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7
-
-      - name: Install dependencies
-        run: bundle install
-
-      - name: Run Rubocop
-        run: bundle exec rubocop

data/.github/workflows/tests.yml

@@ -1,66 +0,0 @@
-name: RSpec tests
-
-on:
-  pull_request:
-  schedule:
-    - cron: '0 0 * * 0'
-
-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'
-
-          - activerecord-gemfile: 'ar_5_latest'
-            ar_lazy_preload-gemfile: 'ar_lazy_preload_master'
-
-    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 }}
-
-      - 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/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.idea
-.rspec_status
-Gemfile.lock
-.ruby-version

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,20 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - examples/**/*
-    - vendor/bundle/**/*
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*

data/CHANGELOG.md

@@ -1,129 +0,0 @@
-## [1.7.1] - 2023/07/30
-
-- Fix interface discrepancy for `N1LoaderReflection`. Thanks [Denis Talakevich](https://github.com/senid231) for suggesting it!
-
-## [1.7.0] - 2023/07/30
-
-Extend the flexibility of loading data comparison. Thanks [Nazar Matus](https://github.com/FunkyloverOne) for suggesting it! 
-
-**BREAKING CHANGES:**
-
-Loose comparison of loaded data. Before loaded data was initialized with identity comparator in mind:
-
-```ruby
-@loaded = {}.compare_by_identity
-```
-
-Now it will be:
-
-```ruby
-@loaded = {}
-```
-
-This might bring unwanted results for cases when strict comparison was wanted. 
-
-On the other hand, it gives more flexibility for many other cases, especially with isolated loader.
-For example, this will work now, when it wasn't working before.
-
-```ruby
-# ActiveRecord object
-object = Entity.first
-
-# Initialize isolated loader
-instance = loader.new([object])
-
-# This was working before because the loaded object is identical to passed object by `#object_id`
-instance.for(object)
-
-# This wasn't working before because the loaded object is not identical to passed one by `#object_id`
-# 
-# But it will be working now, because object == Entity.find(object.id)
-instance.for(Entity.find(object.id))
-```
-
-If you need strict comparison support, please feel free to open the issue or the PR.
-
-## [1.6.6] - 2023/07/30
-
-- Fix naive check of required arguments. Thanks [Nazar Matus](https://github.com/FunkyloverOne) for the issue!
-
-## [1.6.5] - 2023/07/30
-
-- Fix nested preloading for ActiveRecord 7. Thanks [Igor Gonchar](https://github.com/gigorok) for the issue!
-
-## [1.6.4] - 2023/07/30
-
-- Add support of `n1_optimized` ending with `?` (question mark). Thanks [Ilya Kamenko](https://github.com/Galathius) for the suggestion!
-
-## [1.6.3] - 2022/12/30
-
-- Performance optimization: avoid unnecessary calls. Thanks [Nazar Matus](https://github.com/FunkyloverOne) for the [contribution](https://github.com/djezzzl/n1_loader/pull/33).
-
-## [1.6.2] - 2022/11/23
-
-- Add fund metadata
-
-## [1.6.1] - 2022/10/29
-
-- Fix ArLazyPreload context setup when using isolated loaders for objects without the context.
-
-## [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)!
-
-## [1.5.0] - 2022/05/01
-
-- Add support of Rails 7
-
-## [1.4.4] - 2022/04/29
-
-- Inject `N1Loader::Loadable` to `ActiveRecord::Base` automatically
-- Make `reload` to call `n1_clear_cache`
-
-## [1.4.3] - 2022-04-13
-
-- Add `default` support to arguments
-
-## [1.4.2] - 2022-03-01
-
-- Add n1_clear_cache method which is useful for cases like reload in ActiveRecord
-
-## [1.4.1] - 2022-02-24
-
-- Fix preloading of invalid objects
-
-## [1.4.0] - 2022-02-22
-
-- add support of optional arguments
-
-BREAKING CHANGES:
-- rework arguments to use single definition through `argument <name>` only
-- use keyword arguments
-
-## [1.3.0] - 2022-02-22
-
-- add support of named arguments with `argument <name>`
-
-BREAKING CHANGES:
-- rename `n1_load` to `n1_optimized`
-- rework `def self.arguments_key` to `cache_key`
-
-## [1.2.0] - 2022-01-14
-
-- Introduce arguments support.
-
-## [1.1.0] - 2021-12-27
-
-- Introduce `fulfill` method to abstract the storage.
-
-## [1.0.0] - 2021-12-26
-
-- Various of great features.
-
-## [0.1.0] - 2021-12-16
-
-- Initial release.