batch-loader 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dec97d9cd0d12fbc684e4e7f1e68daa1371b028a82cf74ae4413ef2f39692d3
-  data.tar.gz: 4cf02a45980a5beadfba923aaf92e844b269009663b23f5749b48444eff0fba7
+  metadata.gz: 275e001ad653f18baa10d3869939654094e5e57e4139b859e324def6c555f0fd
+  data.tar.gz: 19e4077a85ffc3fc53bdc1faff69be79f377d49f81fc8bf3724517ff28347008
 SHA512:
-  metadata.gz: 4d4d2be50ff4ecac7222e21aeeca4d3f399f823ac27d1d249525a787a1b1e6550c7568301a02be7b9ced07ce8576056bc8769b022ad32ef1d75abf297d6ecf92
-  data.tar.gz: 76560434aac7edd60f61e528a3eb1ad1cd2ed38231faa9d0e5f306a2b8809549567d2553ea28b5805304f22554278b59f51163c0989c094d840ce91343a2159c
+  metadata.gz: 742f9412aa389b2507122ceec3a19fb5e846ea6bffb6a9a87269946960d250b70fcb5c0cfaa2660ff73df8902f3abf38f16900f95e2781465dd8b0e199bce9fd
+  data.tar.gz: 6a4ba810b7f326215920207811456ceb3aa506c17166566e7faa89a6611405d1094f9ce2b78caa56ccd125c6fedfb49fd448cbdaa08cce3f3e881930e946b4d9

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,10 +8,18 @@ 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.1...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v2.0.3...HEAD)
 
 * WIP
 
+#### [v2.0.3](https://github.com/exAspArk/batch-loader/compare/v2.0.2...v2.0.3) - 2024-03-25
+
+* `Fixed`: `Schema.tracer(...)` GraphQL deprecation warning by making it compatible with `.trace_with(...)`. [#91](https://github.com/exAspArk/batch-loader/pull/91)
+
+#### [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)

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(records: records.map(&:object), associations: @preloads).call
+      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

@@ -2,11 +2,20 @@
 
 class BatchLoader
   class GraphQL
+    module Trace
+      def execute_field(**_data)
+        result = yield
+        result.respond_to?(:__sync) ? BatchLoader::GraphQL.wrap_with_warning(result) : result
+      end
+    end
+
     def self.use(schema_definition)
       schema_definition.lazy_resolve(BatchLoader::GraphQL, :sync)
 
       # in cases when BatchLoader is being used instead of BatchLoader::GraphQL
-      if schema_definition.respond_to?(:interpreter?) && schema_definition.interpreter?
+      if schema_definition.respond_to?(:trace_with)
+        schema_definition.trace_with(Trace)
+      elsif schema_definition.respond_to?(:interpreter?) && schema_definition.interpreter?
         schema_definition.tracer(self)
       else
         schema_definition.instrument(:field, self)

data/lib/batch_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class BatchLoader
-  VERSION = "2.0.1"
+  VERSION = "2.0.3"
 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.1
+  version: 2.0.3
 platform: ruby
 authors:
 - exAspArk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2024-03-25 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