n1_loader 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc47894a27d425f70a38dc43b9b40053d823f4815fe8e135a7cb1cf5afbde0f3
-  data.tar.gz: 132d5851c19763db2f1910ebeeb6a368437aba6d3340c2c69ad2ffe348791011
+  metadata.gz: 2d0f96166ae91c856012ea26c933cc56c7d33f68065b753a18adc3c6b9da7e87
+  data.tar.gz: adccc88c382d9283c2af9b41059298fa15563e47615678ef20629a0183a51253
 SHA512:
-  metadata.gz: 945258069b57bc7cd0fe26416411322886d734db0ed4eead1c88a3acced70bdb14ffc92eb9403e5d346c0853d64dc09e5afb8039a9026c9b4c09a1cc6f5fc9e8
-  data.tar.gz: 036e5a8a4b2d63bed2aee558164fdd042ac8c0c68b0ecdb1d5ec9f64231ca9f6841dc56cd6cdc63b87fdb9bf964e4f42089f89d9783cf2513cf81243a473150a
+  metadata.gz: ad3b1273627cf7abb5922cc7139c34e5e9543dc91d296d7e44deea690367d32082dd1ddc028ba40a4ed7fa402a65eb8f5aed36b6d8df0436937e59aaa6cef65a
+  data.tar.gz: fde03e325f2b780a070786f1648a98d278933c84b3266cedf4db50cd268b029839ff06290416846a9ab2a85a25a0795c30684845e4da15909417389dbd1a7a82

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [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>`

data/README.md

@@ -188,21 +188,25 @@ users.map(&:orders_count) # perform will be used once without N+1
 class User
   include N1Loader::Loadable
 
-  n1_optimized :orders_count do |users, type|
-    orders_per_user = Order.where(type: type, user: users).group(:user_id).count
-
-    users.each { |user| fulfill(user, orders_per_user[user.id]) }
+  n1_optimized :orders_count do 
+    argument :type 
+    
+    def perform(users)
+      orders_per_user = Order.where(type: type, user: users).group(:user_id).count
+      
+      users.each { |user| fulfill(user, orders_per_user[user.id]) }
+    end
   end
 end
 
 user = User.new
-user.orders_count(:gifts) # The loader will be performed first time for this argument
-user.orders_count(:sales) # The loader will be performed first time for this argument
-user.orders_count(:gifts) # The cached value will be used
+user.orders_count(type: :gifts) # The loader will be performed first time for this argument
+user.orders_count(type: :sales) # The loader will be performed first time for this argument
+user.orders_count(type: :gifts) # The cached value will be used
 
 users = [User.new, User.new]
 N1Loader::Preloader.new(users).preload(:orders_count)
-users.map { |user| user.orders_count(:gifts) } # No N+1 here
+users.map { |user| user.orders_count(type: :gifts) } # No N+1 here
 ```
 
 _Note_: By default, we use `arguments.map(&:object_id)` to identify arguments but in some cases, 
@@ -217,7 +221,7 @@ class User
     
     cache_key { sale.id }
     
-    def perform(users, sale)
+    def perform(users)
       orders_per_user = Order.where(sale: sale, user: users).group(:user_id).count
       
       users.each { |user| fulfill(user, orders_per_user[user.id]) }
@@ -226,8 +230,8 @@ class User
 end
 
 user = User.new
-user.orders_count(Sale.first) # perform will be executed and value will be cached
-user.orders_count(Sale.first) # the cached value will be returned
+user.orders_count(sale: Sale.first) # perform will be executed and value will be cached
+user.orders_count(sale: Sale.first) # the cached value will be returned
 ```
 
 

data/lib/n1_loader/active_record/loader_collection.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 N1Loader::LoaderCollection.define_method :preloaded_records do
-  unless loader_class.instance_method(:perform).arity == 1
-    raise N1Loader::ActiveRecord::InvalidPreloading, "Cannot preload loader with arguments"
-  end
+  raise N1Loader::ActiveRecord::InvalidPreloading, "Cannot preload loader with arguments" if loader_class.arguments
 
   with.preloaded_records
 end

data/lib/n1_loader/ar_lazy_preload/loader_collection_patch.rb

@@ -6,7 +6,7 @@ module N1Loader
     module LoaderCollectionPatch
       attr_accessor :context_setup
 
-      def with(*args)
+      def with(**args)
         result = super
 
         result.context_setup = context_setup if context_setup && result.context_setup.nil?

data/lib/n1_loader/core/loadable.rb

@@ -47,7 +47,7 @@ module N1Loader
 
       def n1_optimized(name, loader = nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         loader ||= Class.new(N1Loader::Loader) do
-          if block&.arity&.positive?
+          if block.arity == 1
             define_method(:perform, &block)
           else
             class_eval(&block)
@@ -73,10 +73,10 @@ module N1Loader
           instance_variable_get(loader_variable_name) || send("#{loader_name}_reload")
         end
 
-        define_method(name) do |*args, reload: false|
+        define_method(name) do |reload: false, **args|
           send("#{loader_name}_reload") if reload
 
-          send(loader_name).with(*args).for(self)
+          send(loader_name).with(**args).for(self)
         end
 
         [name, loader_name, loader_variable_name]

data/lib/n1_loader/core/loader.rb

@@ -13,11 +13,16 @@ module N1Loader
       #
       # First defined argument will have the value of first passed argument,
       # meaning the order is important.
-      def argument(name)
+      #
+      # @param name [Symbol]
+      # @param opts [Hash]
+      # @option opts [Boolean] optional false by default
+      def argument(name, **opts)
         @arguments ||= []
-        index = @arguments.size
-        define_method(name) { args[index] }
-        @arguments << name
+
+        define_method(name) { args[name] }
+
+        @arguments << opts.merge(name: name)
       end
 
       # Defines a custom cache key that is calculated for passed arguments.
@@ -29,7 +34,7 @@ module N1Loader
       end
     end
 
-    def initialize(elements, *args)
+    def initialize(elements, **args)
       @elements = elements
       @args = args
     end
@@ -44,18 +49,45 @@ module N1Loader
     end
 
     def cache_key
-      args.map(&:object_id)
+      check_arguments!
+      args.values.map(&:object_id)
     end
 
     private
 
     attr_reader :elements, :args
 
+    def check_missing_arguments! # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      return unless (arguments = self.class.arguments)
+
+      min = arguments.count { |argument| !argument[:optional] }
+      max = arguments.count
+
+      return if args.size >= min && args.size <= max
+
+      str =
+        if min == max
+          max.to_s
+        else
+          "#{min}..#{max}"
+        end
+
+      raise MissingArgument, "Loader requires #{str} arguments but #{args.size} were given"
+    end
+
     def check_arguments!
-      return unless (required = self.class.arguments)
-      return if required.size == args.size
+      check_missing_arguments!
+      check_invalid_arguments!
+    end
 
-      raise MissingArgument, "Loader defined #{required.size} arguments but #{args.size} were given"
+    def check_invalid_arguments!
+      return unless (arguments = self.class.arguments)
+
+      args.each_key do |arg|
+        next if arguments.find { |argument| argument[:name] == arg }
+
+        raise InvalidArgument, "Loader doesn't define #{arg} argument"
+      end
     end
 
     def perform(_elements)
@@ -66,7 +98,7 @@ module N1Loader
       @loaded[element] = value
     end
 
-    def loaded # rubocop:disable Metrics/AbcSize
+    def loaded
       return @loaded if @loaded
 
       check_arguments!
@@ -74,9 +106,9 @@ module N1Loader
       @loaded = {}.compare_by_identity
 
       if elements.size == 1 && respond_to?(:single)
-        fulfill(elements.first, single(elements.first, *args))
+        fulfill(elements.first, single(elements.first))
       elsif elements.any?
-        perform(elements, *args)
+        perform(elements)
       end
 
       @loaded

data/lib/n1_loader/core/loader_collection.rb

@@ -10,8 +10,8 @@ module N1Loader
       @elements = elements
     end
 
-    def with(*args)
-      loader = loader_class.new(elements, *args)
+    def with(**args)
+      loader = loader_class.new(elements, **args)
 
       loaders[loader.cache_key] ||= loader
     end

data/lib/n1_loader/version.rb

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

data/lib/n1_loader.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Evgeniy Demin