batch-loader 1.5.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 061a141c0204a3e32aa437b0258e0051b1a0d725de948a762f2444d6994ebfb8
-  data.tar.gz: 9ca768f5ecbe6fe8b72edd4a9161d7aee635023ce111f26f2406a71633a2e2ad
+  metadata.gz: c7ca2d2346f7f08d9830c846f03e7d901f4ce04c6b46f352870497c041531c44
+  data.tar.gz: 86d2deca55bfc7dbaf8166d24b60dd989d535dc63bb371e7567e90828912af75
 SHA512:
-  metadata.gz: c09ec97852edb3ff184a5e5f4fb90e615cdf86b65920a7e9da56e5e4fd633e99ca5252d48a08b8802f860a960539fe5adafebf9b26b910ebe03423fa66b58b3f
-  data.tar.gz: 14769f25d9e61311700997c3008f6df75eaf7b5fbce5db121a36dacbf483246d145862f63c813d4273d30f626690a1941fb17abd1e31b8b91f90d477c67001a1
+  metadata.gz: 132a2a41228ea87f9bbf5bd6fc713518642569415b3ceacdeacb140dc7e4818f13972d5b3b9ef3840ea05475ecaba9e0b0c9b09e0515c42f61abe1d577792b6a
+  data.tar.gz: e560361bca6ee8b57d4a8a56085ba6b626155bbc995b063adb20e947a261935ae38b3fa9415f10981937575abfafef3b5f7dc594c1771263fee51c105f5bb6bf

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/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 .ruby-version
+.tool-versions

data/CHANGELOG.md

@@ -8,11 +8,36 @@ 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.4.1...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v2.0.5...HEAD)
 
 * WIP
 
-#### [v1.5.0](https://github.com/exAspArk/batch-loader/compare/v1.4.1...v1.5.0)
+#### [v2.0.5](https://github.com/exAspArk/batch-loader/compare/v2.0.4...v2.0.5) - 2024-04-24
+
+* `Fixed`: Warning about `BatchLoader` usage instead `BatchLoader::GraphQL` in GraphQL. [#94](https://github.com/exAspArk/batch-loader/pull/94)
+
+#### [v2.0.4](https://github.com/exAspArk/batch-loader/compare/v2.0.3...v2.0.4) - 2024-04-02
+
+* `Fixed`: Chaining `#execute_field` trace calls. [#93](https://github.com/exAspArk/batch-loader/pull/93)
+
+#### [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)
+* `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)
+
+#### [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)
@@ -41,40 +66,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(records: records.map(&:object), associations: @preloads).call
+      records.each { |r| loader.call(r, super(r, args, ctx)) }
+    end
+  end
+end
+```
 
 ### Loading multiple items
 

data/batch-loader.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1.0' # keyword args
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "graphql", "~> 1.6"
-  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "graphql", "~> 1.8"
+  spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "benchmark-ips", "~> 2.7"
   spec.add_development_dependency "ruby-prof", "~> 0.16"
 end

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 = super
+        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)
@@ -36,7 +45,6 @@ class BatchLoader
       warn "DEPRECATION WARNING: using BatchLoader.for in GraphQL is deprecated. Use BatchLoader::GraphQL.for instead or return BatchLoader::GraphQL.wrap from your resolver."
       wrap(batch_loader)
     end
-    private_class_method :wrap_with_warning
 
     def self.wrap(batch_loader)
       BatchLoader::GraphQL.new.tap do |graphql|
@@ -54,8 +62,8 @@ class BatchLoader
       @batch_loader = BatchLoader.for(item)
     end
 
-    def batch(*args, &block)
-      @batch_loader.batch(*args, &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 = "1.5.0"
+  VERSION = "2.0.5"
 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: 1.5.0
+  version: 2.0.5
 platform: ruby
 authors:
 - exAspArk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -127,7 +127,6 @@ files:
 - batch-loader.gemspec
 - bin/console
 - bin/setup
-- graphql-1.7.gemfile
 - graphql-latest.gemfile
 - lib/batch-loader.rb
 - lib/batch_loader.rb
@@ -140,7 +139,7 @@ homepage: https://github.com/exAspArk/batch-loader
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Powerful tool to avoid N+1 DB or HTTP queries
 test_files: []

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-before_install: gem install bundler -v 2.0.1
-rvm:
-  - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-env:
-  - CI=true
-gemfile:
-  - graphql-1.7.gemfile
-  - graphql-latest.gemfile

data/graphql-1.7.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem 'coveralls'
-
-gem "graphql", "~> 1.7.0"
-
-gemspec