batch-loader 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f4ff945285ef2833b1e70fd4c840b5a5dac71184941822cc5e4ed0b699e403
-  data.tar.gz: fa257f5d8e8a43e39300ad916112affb26365b7d9bf98d09a612a8652e512ffc
+  metadata.gz: b25f607d37b2fec3d406a5f3451647a9c66e1f6ec061467c3b293ade83d1df06
+  data.tar.gz: ec1ea4291bf48e05ff606ce6de70908b70275c36a39016c361cc7303a33ebf79
 SHA512:
-  metadata.gz: 998465ddf29713fa411892ce9d88c2195d992444ef2f2e6e22a61fe9c1af036534e580791e7313517e084efb79e46826e9fe6ecf37442b703dc4adc8715954b9
-  data.tar.gz: 9834b2600bc1673d57926a245f463b5f8dd4bf637a59a5c6d384249fe9a6c4d2006adc500884f0593d31db2e81c48cc2bde151605a4e30e79a49530f0114f4bf
+  metadata.gz: 31e92589ff20dc24ca93a4d2e3dece6b0dabd42114988e0ddcdea6f49c58f639656ab66219923bdc26e5673c5878e4b95b347d6844f4ec50d5fbf799b8d1e9e1
+  data.tar.gz: e88f2da06cbd50ba0a92c1327a0d4c4193e7656cc48dac405429c34a4f2e66bce67bbd0c1dffab95e53c04ad741eb33f4a35799fe9dc9cfd214f09fdf4d6f95d

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Run tests
+on:
+  - push
+jobs:
+  run-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 3.2.2
+          - 3.1.4
+          - 3.0.6
+          - 2.7.8
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+      BUNDLE_GEMFILE: ${{ github.workspace }}/graphql-latest.gemfile
+    steps:
+      - name: Checkout a commit
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -8,16 +8,24 @@ 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/v2.0.0...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v2.0.2...HEAD)
 
 * WIP
 
-#### [v2.0.0](https://github.com/exAspArk/batch-loader/compare/v1.5.0...v2.0.0)
+#### [v2.0.2](https://github.com/exAspArk/batch-loader/compare/v2.0.1...v2.0.2) - 2023-11-22
+
+* `Fixed`: Compatibility with Ruby 3 kwargs. [#80](https://github.com/exAspArk/batch-loader/pull/80)
+
+#### [v2.0.1](https://github.com/exAspArk/batch-loader/compare/v2.0.0...v2.0.1) - 2021-02-18
+
+* `Fixed`: Compatibility with GraphQL and Ruby 3. [#71](https://github.com/exAspArk/batch-loader/pull/71)
+* `Changed`: GraphQL tests. [03d5153](https://github.com/exAspArk/batch-loader/commit/03d51537bc4033fd3aab42db3eee3e9e1cb365fa)
+
+#### [v2.0.0](https://github.com/exAspArk/batch-loader/compare/v1.5.0...v2.0.0) - 2021-02-18
 
 * `Removed`: Support for GraphQL version <= 1.7. [#75](https://github.com/exAspArk/batch-loader/pull/75)
-* `Fixed`: Compatibility with Ruby 3. [#71](https://github.com/exAspArk/batch-loader/pull/71)
 
-#### [v1.5.0](https://github.com/exAspArk/batch-loader/compare/v1.4.1...v1.5.0)
+#### [v1.5.0](https://github.com/exAspArk/batch-loader/compare/v1.4.1...v1.5.0) - 2020-04-20
 
 * `Added`: Support for GraphQL Interpreter. [#62](https://github.com/exAspArk/batch-loader/pull/62)
 * `Deprecated`: `BatchLoader.for` in GraphQL. [#62](https://github.com/exAspArk/batch-loader/pull/62)
@@ -46,40 +54,40 @@ def lazy_user
 end
 ```
 
-#### [v1.4.1](https://github.com/exAspArk/batch-loader/compare/v1.4.0...v1.4.1)
+#### [v1.4.1](https://github.com/exAspArk/batch-loader/compare/v1.4.0...v1.4.1) - 2019-05-24
 
 * `Fixes`: Does not allow mutating and corrupting a list of items in a `batch` block. [#46](https://github.com/exAspArk/batch-loader/pull/46)
 
-#### [v1.4.0](https://github.com/exAspArk/batch-loader/compare/v1.3.0...v1.4.0)
+#### [v1.4.0](https://github.com/exAspArk/batch-loader/compare/v1.3.0...v1.4.0) - 2019-04-29
 
 * `Added`: new `replace_methods` argument to `BatchLoader#batch` to allow control over `define_method` calls. [#45](https://github.com/exAspArk/batch-loader/pull/45)
 
-#### [v1.3.0](https://github.com/exAspArk/batch-loader/compare/v1.2.2...v1.3.0)
+#### [v1.3.0](https://github.com/exAspArk/batch-loader/compare/v1.2.2...v1.3.0) - 2019-02-01
 
 * `Added`: `BatchLoader::GraphQL.for` to make it compatible with `graphql` gem versions `>= 1.8.7`. [#30](https://github.com/exAspArk/batch-loader/issues/30)
 
-#### [v1.2.2](https://github.com/exAspArk/batch-loader/compare/v1.2.1...v1.2.2)
+#### [v1.2.2](https://github.com/exAspArk/batch-loader/compare/v1.2.1...v1.2.2) - 2018-12-03
 
 * `Fixed`: Identify item by `key` object instead of `key` string representation. [#27](https://github.com/exAspArk/batch-loader/pull/27)
 
-#### [v1.2.1](https://github.com/exAspArk/batch-loader/compare/v1.2.0...v1.2.1)
+#### [v1.2.1](https://github.com/exAspArk/batch-loader/compare/v1.2.0...v1.2.1) - 2017-12-16
 
 * `Fixed`: Do not depend on `method_missing` for `respond_to?`. [#14](https://github.com/exAspArk/batch-loader/pull/14)
 
-#### [v1.2.0](https://github.com/exAspArk/batch-loader/compare/v1.1.1...v1.2.0)
+#### [v1.2.0](https://github.com/exAspArk/batch-loader/compare/v1.1.1...v1.2.0) - 2017-11-16
 
 * `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)
+#### [v1.1.1](https://github.com/exAspArk/batch-loader/compare/v1.1.0...v1.1.1) - 2017-11-06
 
 * `Fixed`: `loader`, made it thread-safe again. [#10](https://github.com/exAspArk/batch-loader/pull/10)
 
-#### [v1.1.0](https://github.com/exAspArk/batch-loader/compare/v1.0.4...v1.1.0)
+#### [v1.1.0](https://github.com/exAspArk/batch-loader/compare/v1.0.4...v1.1.0) - 2017-11-02
 
 * `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)
+#### [v1.0.4](https://github.com/exAspArk/batch-loader/compare/v1.0.3...v1.0.4) - 2017-10-12
 
 * `Fixed`: Fix arity bug in `respond_to?` [#3](https://github.com/exAspArk/batch-loader/pull/3)
 

data/README.md

@@ -1,6 +1,5 @@
 # BatchLoader
 
-[![Build Status](https://travis-ci.org/exAspArk/batch-loader.svg?branch=master)](https://travis-ci.org/exAspArk/batch-loader)
 [![Coverage Status](https://coveralls.io/repos/github/exAspArk/batch-loader/badge.svg)](https://coveralls.io/github/exAspArk/batch-loader)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/exAspArk/batch-loader.svg)](https://codeclimate.com/github/exAspArk/batch-loader/maintainability)
 [![Downloads](https://img.shields.io/gem/dt/batch-loader.svg)](https://rubygems.org/gems/batch-loader)
@@ -256,7 +255,7 @@ module Types
     field :user, UserType, null: false
 
     def user
-      post.user # N+1 queries
+      object.user # N+1 queries
     end
   end
 end
@@ -295,7 +294,7 @@ module Types
     field :user, UserType, null: false
 
     def user
-      BatchLoader::GraphQL.for(post.user_id).batch do |user_ids, loader|
+      BatchLoader::GraphQL.for(object.user_id).batch do |user_ids, loader|
         User.where(id: user_ids).each { |user| loader.call(user.id, user) }
       end
     end
@@ -312,7 +311,39 @@ class MyProjectSchema < GraphQL::Schema
 end
 ```
 
-That's it.
+---
+
+If you need to use BatchLoader with ActiveRecord in multiple places, you can use this `preload:` helper shared by [Aha!](https://www.aha.io/engineering/articles/automatically-avoiding-graphql-n-1s):
+
+```rb
+field :user, UserType, null: false, preload: :user
+#                                   ^^^^^^^^^^^^^^
+# Simply add this instead of defining custom `user` method with BatchLoader
+```
+
+And add this custom field resolver that uses ActiveRecord's preload functionality with BatchLoader:
+
+```rb
+# app/graphql/types/base_object.rb
+field_class Types::PreloadableField
+
+# app/graphql/types/preloadable_field.rb
+class Types::PreloadableField < Types::BaseField
+  def initialize(*args, preload: nil, **kwargs, &block)
+    @preloads = preload
+    super(*args, **kwargs, &block)
+  end
+
+  def resolve(type, args, ctx)
+    return super unless @preloads
+
+    BatchLoader::GraphQL.for(type).batch(key: self) do |records, loader|
+      ActiveRecord::Associations::Preloader.new.preload(records.map(&:object), @preloads)
+      records.each { |r| loader.call(r, super(r, args, ctx)) }
+    end
+  end
+end
+```
 
 ### Loading multiple items
 

data/graphql-latest.gemfile

@@ -2,6 +2,6 @@ source "https://rubygems.org"
 
 gem 'coveralls'
 
-gem "graphql", ">= 1.8"
+gem "graphql", "~> 1.8"
 
 gemspec

data/lib/batch_loader/graphql.rb

@@ -54,8 +54,8 @@ class BatchLoader
       @batch_loader = BatchLoader.for(item)
     end
 
-    def batch(*kwargs, &block)
-      @batch_loader.batch(*kwargs, &block)
+    def batch(**kwargs, &block)
+      @batch_loader.batch(**kwargs, &block)
       self
     end
 

data/lib/batch_loader/version.rb

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

data/lib/batch_loader.rb

@@ -69,8 +69,8 @@ class BatchLoader
     @cache ? @loaded_value : result
   end
 
-  def method_missing(method_name, *args, &block)
-    __sync!.public_send(method_name, *args, &block)
+  def method_missing(method_name, *args, **kwargs, &block)
+    __sync!.public_send(method_name, *args, **kwargs, &block)
   end
 
   def __sync!
@@ -120,8 +120,8 @@ class BatchLoader
   def __replace_with!(value)
     __singleton_class.class_eval do
       (value.methods - LEFT_INSTANCE_METHODS).each do |method_name|
-        define_method(method_name) do |*args, &block|
-          value.public_send(method_name, *args, &block)
+        define_method(method_name) do |*args, **kwargs, &block|
+          value.public_send(method_name, *args, **kwargs, &block)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch-loader
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - exAspArk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Powerful tool to avoid N+1 DB or HTTP queries

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-before_install: gem install bundler -v 2.0.1
-rvm:
-  - 2.3.8
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-env:
-  - CI=true
-gemfile:
-  - graphql-latest.gemfile