n1_loader 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86d093c173eed577feb029f483c8b283f516bba1611391f9036e5675dec91d5
-  data.tar.gz: 626e0305af7e75fd6a5dbb23d6970a8972ca292a9449f2f32d61cf7849c57ec9
+  metadata.gz: 8a365bb6b58a962185cd24033f6dd6cb98510712973dacdea4977a3121b64adc
+  data.tar.gz: d06031503475dc13f52acddb881931de5b7dd244acab6b46553d4a73c8efbd2d
 SHA512:
-  metadata.gz: 3b450b20c25c935d3644003bf320e50644376cb6fc77cbda414522947a50857c3b28c5607bbcfd484dd9626a64523726cb4c6dd98b402a9ed3b73f1d6a40785a
-  data.tar.gz: 9d07c4a64e89f2c2e9aa230d86c780388aaf720002db5fac37fe9b98ffd6297b914ab49ec54306c728c3457ea7a323a52d66c3c9e78c40ccbaed0a511be1f012
+  metadata.gz: 9172c4cd233739a0ebc379b3988037349d028020d5eb066642532f2b3da2a75d3faa34edd872aa5b5925eed91509c2c3a202e7a9aa448ca5020435b4f5e9c5a5
+  data.tar.gz: e74f92e69f47909b812adecb1aa7dc319c090a2ad865e89732a4ebdbbd378c02dbec28cc7ff5b0ff42262acf3a07e8deb8a4a949634d70c6d6c3986837a6ab5d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.1.0] - 2021-12-27
+
+- Introduce `fulfill` method to abstract the storage.
+
 ## [1.0.0] - 2021-12-26
 
 - Various of great features.

data/README.md

@@ -47,8 +47,7 @@ class Example
 
   # with inline loader
   n1_loader :anything do |elements|
-    # Has to return a hash that has keys as element from elements
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 
   # with custom loader
@@ -57,9 +56,8 @@ end
 
 # Custom loader that can be shared with many classes
 class MyLoader < N1Loader::Loader
-  # Has to return a hash that has keys as element from elements
   def perform(elements)
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 end
 
@@ -80,8 +78,7 @@ class Example
   include N1Loader::Loadable
   
   n1_loader :anything do |elements|
-    # Has to return a hash that has keys as element from elements
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 end
 
@@ -99,8 +96,7 @@ objects.map(&:anything) # => loading happen for the first time (without N+1)
 ```ruby
 class MyLoader < N1Loader::Loader
   def perform(elements)
-    # Has to return a hash that has keys as element from elements
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 end
 
@@ -128,8 +124,7 @@ class Example
 
   # with inline loader
   n1_loader :anything do |elements|
-    # Has to return a hash that has keys as element from elements
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 end
 
@@ -151,8 +146,7 @@ objects.map(&:anything) # => new loader was executed first time without N+1 issu
 ```ruby
 class MyLoader < N1Loader::Loader
   def perform(elements)
-    # Has to return a hash that has keys as element from elements
-    elements.group_by(&:itself)
+    elements.each { |element| fulfill(element, [element]) }
   end
 end
 
@@ -171,14 +165,13 @@ class Example
   
   n1_loader :something do # no arguments passed to the block, so we can override both perform and single.
     def perform(elements)
-      # Has to return a hash that has keys as element from elements
-      elements.group_by(&:itself)
+      elements.each { |element| fulfill(element, [element]) }
     end
     
     # Optimized for single object loading
     def single(element)
       # Just return a value you want to have for this element
-      element
+      [element]
     end
   end
 end
@@ -206,8 +199,7 @@ class User < ActiveRecord::Base
   n1_loader :orders_count do |users|
     hash = Order.where(user: users).group(:user_id).count
     
-    # hash has to have keys as initial elements
-    hash.transform_keys! { |key| users.find { |user| user.id == key } }
+    users.each { |user| fulfill(user, hash[user.id]) }
   end
 end
 
@@ -234,9 +226,8 @@ class User < ActiveRecord::Base
   
   n1_loader :orders_count do |users|
     hash = Order.where(user: users).group(:user_id).count
-    
-    # hash has to have keys as initial elements
-    hash.transform_keys! { |key| users.find { |user| user.id == key } }
+
+    users.each { |user| fulfill(user, hash[user.id]) }
   end
 end
 

data/lib/n1_loader/active_record/loader.rb

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

data/lib/n1_loader/active_record.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../n1_loader"
-
+require_relative "active_record/loader"
 require "active_record"
 
 ActiveSupport.on_load(:active_record) do

data/lib/n1_loader/core/loadable.rb

@@ -8,9 +8,7 @@ module N1Loader
   #
   #     # with inline loader
   #     n1_loader :something do |elements|
-  #       elements.each_with_object({}) do |element, hash|
-  #         hash[element] = element.calculate_something
-  #       end
+  #       elements.each { |element| fulfill(element,, element.calculate_something) }
   #     end
   #
   #     # with custom loader
@@ -20,9 +18,7 @@ module N1Loader
   #   # custom loader
   #   class MyLoader < N1Loader::Loader
   #     def perform(elements)
-  #       elements.each_with_object({}) do |element, hash|
-  #         hash[element] = element.calculate_something
-  #       end
+  #       elements.each { |element| fulfill(element,, element.calculate_something) }
   #     end
   #   end
   module Loadable

data/lib/n1_loader/core/loader.rb

@@ -10,30 +10,39 @@ module N1Loader
       @elements = elements
     end
 
-    def perform(_elements)
-      raise NotImplemented, "Subclasses have to implement the method"
+    def for(element)
+      if loaded.empty? && elements.any?
+        raise NotFilled, "Nothing was preloaded, perhaps you forgot to use fulfill method"
+      end
+      raise NotLoaded, "The data was not preloaded for the given element" unless loaded.key?(element)
+
+      loaded[element]
     end
 
-    def loaded
-      @loaded ||= if elements.size == 1 && respond_to?(:single)
-                    { elements.first => single(elements.first) }
-                  else
-                    perform(elements)
-                  end
+    private
+
+    attr_reader :elements
+
+    def perform(_elements)
+      raise NotImplemented, "Subclasses have to implement the method"
     end
 
-    def preloaded_records
-      @preloaded_records ||= loaded.values
+    def fulfill(element, value)
+      @loaded[element] = value
     end
 
-    def for(element)
-      raise NotLoaded, "The data was not preloaded for the given element" unless elements.include?(element)
+    def loaded
+      return @loaded if @loaded
 
-      loaded.compare_by_identity[element]
-    end
+      @loaded = {}.compare_by_identity
 
-    private
+      if elements.size == 1 && respond_to?(:single)
+        fulfill(elements.first, single(elements.first))
+      elsif elements.any?
+        perform(elements)
+      end
 
-    attr_reader :elements
+      @loaded
+    end
   end
 end

data/lib/n1_loader/version.rb

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

data/lib/n1_loader.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n1_loader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,7 @@ files:
 - lib/n1_loader/active_record.rb
 - lib/n1_loader/active_record/associations_preloader_v5.rb
 - lib/n1_loader/active_record/associations_preloader_v6.rb
+- lib/n1_loader/active_record/loader.rb
 - lib/n1_loader/ar_lazy_preload.rb
 - lib/n1_loader/ar_lazy_preload/associated_context_builder.rb
 - lib/n1_loader/ar_lazy_preload/context_adapter.rb