batch-loader 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e25c611b667937e94fa71fc53d7ca0e0610914
-  data.tar.gz: bf88a43be0f71991ea587d9f1a9cd7de0c63310c
+  metadata.gz: 124dbf8b2fa20f0e0fd6bca686449f48c3dd3625
+  data.tar.gz: d10abd20d3f55f64871673b5410c8d92539abaa5
 SHA512:
-  metadata.gz: 23317a63530d9067930446a9426f34f54b78d8a991c2901558b1c79558b7941291dedbfd58b843195cae19e6fac4288668a7176273c64320419dc4621ac23a16
-  data.tar.gz: 5ce2b962b3948e6a579b1631e500d81c3a48e0eaa7bddf22fbbf00d081c39fda88beb6803531848fce5aa5bbe6e9ac243aaa69174e1127b5109cf7a1cd70cc96
+  metadata.gz: 4e97a8dcbb31e6310dc2b40df35143f6bdac4a1153b1ea9de175f07b36e8df0da7890e1c445f91c782e3ac1804ee0129107329685e0aac50dcafadbe17278c3a
+  data.tar.gz: 93188a2738ac3f57735e0643003818b19eb4875c2b748fbbf0e19751c837a8ba32247b84fa84533bb2bbe84515eb35fc28f31929813871c6eb21b9fc08a1d4b8

data/CHANGELOG.md

@@ -8,11 +8,16 @@ one of the following labels: `Added`, `Changed`, `Deprecated`,
 to manage the versions of this gem so
 that you can set version constraints properly.
 
-#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.0.4...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.1.0...HEAD)
 
 * WIP
 
-#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.0.3...v1.0.4)
+#### [v1.1.0](https://github.com/exAspArk/batch-loader/compare/v1.0.4...v1.1.0)
+
+* `Added`: `default_value` override option. [#8](https://github.com/exAspArk/batch-loader/pull/8)
+* `Added`: `loader.call {}` block syntax, for memoizing repeat calls to the same item. [#8](https://github.com/exAspArk/batch-loader/pull/8)
+
+#### [v1.0.4](https://github.com/exAspArk/batch-loader/compare/v1.0.3...v1.0.4)
 
 * `Fixed`: Fix arity bug in `respond_to?` [#3](https://github.com/exAspArk/batch-loader/pull/3)
 

data/README.md

@@ -17,6 +17,7 @@ This gem provides a generic lazy batching mechanism to avoid N+1 DB queries, HTT
   * [How it works](#how-it-works)
   * [RESTful API example](#restful-api-example)
   * [GraphQL example](#graphql-example)
+  * [Loading multiple items](#loading-multiple-items)
   * [Caching](#caching)
 * [Installation](#installation)
 * [Implementation details](#implementation-details)
@@ -279,6 +280,26 @@ end
 
 That's it.
 
+### Loading multiple items
+
+For batches where there is no item in response to a call, we normally return `nil`. However, you can use `:default_value` to return something else instead:
+
+```ruby
+BatchLoader.for(post.user_id).batch(default_value: NullUser.new) do |user_ids, loader|
+  User.where(id: user_ids).each { |user| loader.call(user.id, user) }
+end
+```
+
+For batches where the value is some kind of collection, such as an Array or Hash, `loader` also supports being called with a block, which yields the _current_ value, and returns the _next_ value. This is extremely useful for 1:Many relationships:
+
+```ruby
+BatchLoader.for(user.id).batch(default_value: []) do |comment_ids, loader|
+  Comment.where(user_id: user_ids).each do |comment|
+    loader.call(user.id) { |memo| memo << comment }
+  end
+end
+```
+
 ### Caching
 
 By default `BatchLoader` caches the loaded values. You can test it by running something like:

data/lib/batch_loader.rb

@@ -22,7 +22,8 @@ class BatchLoader
     @item = item
   end
 
-  def batch(cache: true, &batch_block)
+  def batch(default_value: nil, cache: true, &batch_block)
+    @default_value = default_value
     @cache = cache
     @batch_block = batch_block
     __executor_proxy.add(item: @item)
@@ -75,12 +76,21 @@ class BatchLoader
     return if __executor_proxy.value_loaded?(item: @item)
 
     items = __executor_proxy.list_items
-    loader = ->(item, value) { __executor_proxy.load(item: item, value: value) }
+    loader =  -> (item, value = (no_value = true; nil), &block) {
+      if no_value && !block
+        raise ArgumentError, "Please pass a value or a block"
+      elsif block && !no_value
+        raise ArgumentError, "Please pass a value or a block, not both"
+      end
+
+      next_value = block ? block.call(__executor_proxy.loaded_value(item: item)) : value
+      __executor_proxy.load(item: item, value: next_value)
+    }
 
     @batch_block.call(items, loader)
     items.each do |item|
       next if __executor_proxy.value_loaded?(item: item)
-      loader.call(item, nil) # use "nil" for not loaded item after succesfull batching
+      loader.call(item, @default_value)
     end
     __executor_proxy.delete(items: items)
   end
@@ -109,7 +119,7 @@ class BatchLoader
   def __executor_proxy
     @__executor_proxy ||= begin
       raise NoBatchError.new("Please provide a batch block first") unless @batch_block
-      BatchLoader::ExecutorProxy.new(&@batch_block)
+      BatchLoader::ExecutorProxy.new(@default_value, &@batch_block)
     end
   end
 

data/lib/batch_loader/executor_proxy.rb

@@ -4,9 +4,10 @@ require_relative "./executor"
 
 class BatchLoader
   class ExecutorProxy
-    attr_reader :block, :global_executor
+    attr_reader :default_value, :block, :global_executor
 
-    def initialize(&block)
+    def initialize(default_value, &block)
+      @default_value = default_value
       @block = block
       @block_hash_key = block.source_location
       @global_executor = BatchLoader::Executor.ensure_current
@@ -29,7 +30,11 @@ class BatchLoader
     end
 
     def loaded_value(item:)
-      loaded[item]
+      if value_loaded?(item: item)
+        loaded[item]
+      else
+        @default_value.dup
+      end
     end
 
     def value_loaded?(item:)

data/lib/batch_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class BatchLoader
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch-loader
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - exAspArk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler