n1_loader 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b9b61121f94d9dba30e969c1b9a3fa9c812292d618434a98262c90aef43e6cd
-  data.tar.gz: a1ecf5359a1a53200e354b30289566a437cf372c54ccf3f13c2e0adc2cb71640
+  metadata.gz: cc47894a27d425f70a38dc43b9b40053d823f4815fe8e135a7cb1cf5afbde0f3
+  data.tar.gz: 132d5851c19763db2f1910ebeeb6a368437aba6d3340c2c69ad2ffe348791011
 SHA512:
-  metadata.gz: 5c545cc2033dc8e75edddd5c948eed78fc1d965464522147841d30e3c6a02aebb0b6758d3f801b020c25d62618f7ae4bbb7ff11441748f798546351b1bf34d85
-  data.tar.gz: a60fa813399debf1ae9c8f839272a683c2a7f733ea392b4b1bd4169af55369a1d3be2fd8648a548e50093005e3d2df962437adf08f1f9fdf1338fa4ab6217df7
+  metadata.gz: 945258069b57bc7cd0fe26416411322886d734db0ed4eead1c88a3acced70bdb14ffc92eb9403e5d346c0853d64dc09e5afb8039a9026c9b4c09a1cc6f5fc9e8
+  data.tar.gz: 036e5a8a4b2d63bed2aee558164fdd042ac8c0c68b0ecdb1d5ec9f64231ca9f6841dc56cd6cdc63b87fdb9bf964e4f42089f89d9783cf2513cf81243a473150a

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [1.2.0]
+## [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.
 

data/README.md

@@ -45,7 +45,7 @@ class User
   include N1Loader::Loadable
 
   # with inline loader
-  n1_loader :orders_count do |users|
+  n1_optimized :orders_count do |users|
     orders_per_user = Order.where(user: users).group(:user_id).count
     
     users.each { |user| fulfill(user, orders_per_user[user.id]) }
@@ -69,7 +69,7 @@ class User
   include N1Loader::Loadable
 
   # with inline loader
-  n1_loader :orders_count do |users|
+  n1_optimized :orders_count do |users|
     orders_per_user = Order.where(user: users).group(:user_id).count
 
     users.each { |user| fulfill(user, orders_per_user[user.id]) }
@@ -98,14 +98,14 @@ end
 
 class User
   include N1Loader::Loadable
-  
-  n1_loader :orders_count, OrdersCountLoader
+
+  n1_optimized :orders_count, OrdersCountLoader
 end
 
 class Customer
   include N1Loader::Loadable
-  
-  n1_loader :orders_count, OrdersCountLoader
+
+  n1_optimized :orders_count, OrdersCountLoader
 end
 
 User.new.orders_count # => works
@@ -119,7 +119,7 @@ class User
   include N1Loader::Loadable
 
   # with inline loader
-  n1_loader :orders_count do |users|
+  n1_optimized :orders_count do |users|
     orders_per_user = Order.where(user: users).group(:user_id).count
 
     users.each { |user| fulfill(user, orders_per_user[user.id]) }
@@ -159,8 +159,8 @@ end
 ```ruby
 class User
   include N1Loader::Loadable
-  
-  n1_loader :orders_count do # no arguments passed to the block, so we can override both perform and single.
+
+  n1_optimized :orders_count do # no arguments passed to the block, so we can override both perform and single.
     def perform(users)
       orders_per_user = Order.where(user: users).group(:user_id).count
 
@@ -188,7 +188,7 @@ users.map(&:orders_count) # perform will be used once without N+1
 class User
   include N1Loader::Loadable
 
-  n1_loader :orders_count do |users, type|
+  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]) }
@@ -212,16 +212,16 @@ you may want to override it, for example:
 class User
   include N1Loader::Loadable
 
-  n1_loader :orders_count do
+  n1_optimized :orders_count do
+    argument :sale 
+    
+    cache_key { sale.id }
+    
     def perform(users, sale)
       orders_per_user = Order.where(sale: sale, user: users).group(:user_id).count
       
       users.each { |user| fulfill(user, orders_per_user[user.id]) }
     end
-
-    def self.arguments_key(sale)
-      sale.id
-    end
   end
 end
 
@@ -235,11 +235,13 @@ user.orders_count(Sale.first) # the cached value will be returned
 
 ### [ActiveRecord][5]
 
+_Note_: Rails 7 support is coming soon! Stay tuned!
+
 ```ruby
 class User < ActiveRecord::Base
   include N1Loader::Loadable
-  
-  n1_loader :orders_count do |users|
+
+  n1_optimized :orders_count do |users|
     orders_per_user = Order.where(user: users).group(:user_id).count
 
     users.each { |user| fulfill(user, orders_per_user[user.id]) }
@@ -266,8 +268,8 @@ users.map(&:orders_count)
 ```ruby
 class User < ActiveRecord::Base
   include N1Loader::Loadable
-  
-  n1_loader :orders_count do |users|
+
+  n1_optimized :orders_count do |users|
     orders_per_user = Order.where(user: users).group(:user_id).count
 
     users.each { |user| fulfill(user, orders_per_user[user.id]) }

data/lib/n1_loader/ar_lazy_preload/loadable.rb

@@ -4,7 +4,7 @@ module N1Loader
   module ArLazyPreload
     module Loadable
       module ClassMethods # :nodoc:
-        def n1_load(name, loader = nil, &block)
+        def n1_optimized(name, loader = nil, &block)
           name, loader_name, loader_variable_name = super
 
           define_method(loader_name) do

data/lib/n1_loader/core/loadable.rb

@@ -45,7 +45,7 @@ module N1Loader
         respond_to?("#{name}_loader")
       end
 
-      def n1_load(name, loader = nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def n1_optimized(name, loader = nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         loader ||= Class.new(N1Loader::Loader) do
           if block&.arity&.positive?
             define_method(:perform, &block)

data/lib/n1_loader/core/loader.rb

@@ -6,8 +6,27 @@ module N1Loader
   # Subclasses must define +perform+ method that accepts single argument
   # and returns hash where key is the element and value is what we want to load.
   class Loader
-    def self.arguments_key(*args)
-      args.map(&:object_id)
+    class << self
+      attr_reader :arguments
+
+      # Defines an argument that can be accessed within the loader.
+      #
+      # First defined argument will have the value of first passed argument,
+      # meaning the order is important.
+      def argument(name)
+        @arguments ||= []
+        index = @arguments.size
+        define_method(name) { args[index] }
+        @arguments << name
+      end
+
+      # Defines a custom cache key that is calculated for passed arguments.
+      def cache_key(&block)
+        define_method(:cache_key) do
+          check_arguments!
+          instance_exec(&block)
+        end
+      end
     end
 
     def initialize(elements, *args)
@@ -24,10 +43,21 @@ module N1Loader
       loaded[element]
     end
 
+    def cache_key
+      args.map(&:object_id)
+    end
+
     private
 
     attr_reader :elements, :args
 
+    def check_arguments!
+      return unless (required = self.class.arguments)
+      return if required.size == args.size
+
+      raise MissingArgument, "Loader defined #{required.size} arguments but #{args.size} were given"
+    end
+
     def perform(_elements)
       raise NotImplemented, "Subclasses have to implement the method"
     end
@@ -36,9 +66,11 @@ module N1Loader
       @loaded[element] = value
     end
 
-    def loaded
+    def loaded # rubocop:disable Metrics/AbcSize
       return @loaded if @loaded
 
+      check_arguments!
+
       @loaded = {}.compare_by_identity
 
       if elements.size == 1 && respond_to?(:single)

data/lib/n1_loader/core/loader_collection.rb

@@ -11,7 +11,9 @@ module N1Loader
     end
 
     def with(*args)
-      loaders[loader_class.arguments_key(*args)] ||= loader_class.new(elements, *args)
+      loader = loader_class.new(elements, *args)
+
+      loaders[loader.cache_key] ||= loader
     end
 
     private

data/lib/n1_loader/version.rb

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

data/lib/n1_loader.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord