batch-loader 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb2bec5ff8fdc6fd2c2ec099c1db9ca07916594
-  data.tar.gz: af763f4dc852c3f2b4ca73a3ce0ff639ea544f0a
+  metadata.gz: aa05684af093fc9efd4873f256fd0a173179609c
+  data.tar.gz: 9e7e5751b5bba6b43f0cf8bce0e32fd64885a194
 SHA512:
-  metadata.gz: 699d6d95a80c2b7b7c366979277bb003c0eada94ea087df1812b2b1754ac70d6a518608bd25c7ae3d6665d6d0629c9836811c2e9d0e07bf3879064bf4f0b11c7
-  data.tar.gz: 614b0b57b84e80a7f1de5af9d961c4ca78252e4c84e3a624fa49a25810acae7c6ec2648c8a573cddc2b9620896645d966d79b8c936c02f09b3cca0eb1a445d18
+  metadata.gz: '08d5499226c25e153e4587358e8f38cd88950fe4d216578ea5b82b71f77ca381bd07f0383bda26e54edd56ffb4c92b458028857f1db7d770101039c548d0838e'
+  data.tar.gz: '02913dc9ee5cc57e952ecd49a7636d275d7343990c574a3f14ff0ddf7ed662991cfdd4f8b722c0dcca54b86996d9a4377ebf4f5582075bf54670657dc8c0c30d'

data/CHANGELOG.md

@@ -8,10 +8,14 @@ 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.1.1...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.2.0...HEAD)
 
 * WIP
 
+#### [v1.2.0](https://github.com/exAspArk/batch-loader/compare/v1.1.1...v1.2.0)
+
+* `Added`: `key` argument for the `BatchLoader#batch` method. [#12](https://github.com/exAspArk/batch-loader/pull/12)
+
 #### [v1.1.1](https://github.com/exAspArk/batch-loader/compare/v1.1.0...v1.1.1)
 
 * `Fixed`: `loader`, made it thread-safe again. [#10](https://github.com/exAspArk/batch-loader/pull/10)

data/README.md

@@ -18,8 +18,10 @@ This gem provides a generic lazy batching mechanism to avoid N+1 DB queries, HTT
   * [RESTful API example](#restful-api-example)
   * [GraphQL example](#graphql-example)
   * [Loading multiple items](#loading-multiple-items)
+  * [Batch key](#batch-key)
   * [Caching](#caching)
 * [Installation](#installation)
+* [API](#api)
 * [Implementation details](#implementation-details)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -300,6 +302,30 @@ BatchLoader.for(user.id).batch(default_value: []) do |comment_ids, loader|
 end
 ```
 
+### Batch key
+
+It's possible to reuse the same `BatchLoader#batch` block for loading different types of data by specifying a unique `key`.
+For example, with polymorphic associations:
+
+```ruby
+def lazy_association(post)
+  id = post.association_id
+  key = post.association_type
+
+  BatchLoader.for(id).batch(key: key) do |ids, loader, args|
+    model = Object.const_get(args[:key])
+    model.where(id: ids).each { |record| record.call(record.id, record) }
+  end
+end
+post1 = Post.save(association_id: 1, association_type: 'Tag')
+post2 = Post.save(association_id: 1, association_type: 'Category')
+
+lazy_association(post1) # SELECT * FROM tags WHERE id IN (1)
+lazy_association(post2) # SELECT * FROM categories WHERE id IN (1)
+```
+
+It's also required to pass custom `key` when using `BatchLoader` with metaprogramming (e.g. `eval`).
+
 ### Caching
 
 By default `BatchLoader` caches the loaded values. You can test it by running something like:
@@ -364,6 +390,24 @@ Or install it yourself as:
 
     $ gem install batch-loader
 
+## API
+
+```ruby
+BatchLoader.for(item).batch(default_value: default_value, cache: cache, key: key) do |items, loader, args|
+  # ...
+end
+```
+
+| Argument Key    | Default                                       | Description                                                   |
+| --------------- | --------------------------------------------- | ------------------------------------------------------------- |
+| `item`          | -                                             | Item which will be collected and used for batching.           |
+| `default_value` | `nil`                                         | Value returned by default after batching.                     |
+| `cache`         | `true`                                        | Set `false` to disable caching between the same executions.   |
+| `key`           | `nil`                                         | Pass custom key to uniquely identify the batch block.         |
+| `items`         | -                                             | List of collected items for batching.                         |
+| `loader`        | -                                             | Lambda which should be called to load values loaded in batch. |
+| `args`          | `{default_value: nil, cache: true, key: nil}` | Arguments passed to the `batch` method.                       |
+
 ## Implementation details
 
 See the [slides](https://speakerdeck.com/exaspark/batching-a-powerful-way-to-solve-n-plus-1-queries) [37-42].

data/lib/batch_loader.rb

@@ -23,9 +23,10 @@ class BatchLoader
     @__executor_proxy = executor_proxy
   end
 
-  def batch(default_value: nil, cache: true, &batch_block)
+  def batch(default_value: nil, cache: true, key: nil, &batch_block)
     @default_value = default_value
     @cache = cache
+    @key = key
     @batch_block = batch_block
     __executor_proxy.add(item: @item)
 
@@ -78,7 +79,8 @@ class BatchLoader
 
     items = __executor_proxy.list_items
     loader = __loader
-    @batch_block.call(items, loader)
+    args = {default_value: @default_value, cache: @cache, key: @key}
+    @batch_block.call(items, loader, args)
     items.each do |item|
       next if __executor_proxy.value_loaded?(item: item)
       loader.call(item, @default_value)
@@ -126,7 +128,7 @@ class BatchLoader
   def __executor_proxy
     @__executor_proxy ||= begin
       raise NoBatchError.new("Please provide a batch block first") unless @batch_block
-      BatchLoader::ExecutorProxy.new(@default_value, &@batch_block)
+      BatchLoader::ExecutorProxy.new(@default_value, @key, &@batch_block)
     end
   end
 

data/lib/batch_loader/executor_proxy.rb

@@ -6,10 +6,10 @@ class BatchLoader
   class ExecutorProxy
     attr_reader :default_value, :block, :global_executor
 
-    def initialize(default_value, &block)
+    def initialize(default_value, key, &block)
       @default_value = default_value
       @block = block
-      @block_hash_key = block.source_location
+      @block_hash_key = "#{key}#{block.source_location}"
       @global_executor = BatchLoader::Executor.ensure_current
     end
 

data/lib/batch_loader/version.rb

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

metadata

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