batch-loader 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c89e0468fac3840ce82631d0a0f9ac61eeda081
-  data.tar.gz: ec6c5021e04a5bc067356305659325431caa2753
+SHA256:
+  metadata.gz: c1f4ff945285ef2833b1e70fd4c840b5a5dac71184941822cc5e4ed0b699e403
+  data.tar.gz: fa257f5d8e8a43e39300ad916112affb26365b7d9bf98d09a612a8652e512ffc
 SHA512:
-  metadata.gz: 6551811eace7cb180cdea08c28b77695d8c243af3e6675e9da8d172645cab35ba51803f036359c4ecd8a6cc65a1ec2b95e2b1824f829c0454da2c0570748e396
-  data.tar.gz: 78c0481961a045060a64c155ddb196f125da805944014ad59052464fb7b3a884e41cd6462ab5ceb186931cbcbd1e210f61d963007e4af8f1124809a2ec698e62
+  metadata.gz: 998465ddf29713fa411892ce9d88c2195d992444ef2f2e6e22a61fe9c1af036534e580791e7313517e084efb79e46826e9fe6ecf37442b703dc4adc8715954b9
+  data.tar.gz: 9834b2600bc1673d57926a245f463b5f8dd4bf637a59a5c6d384249fe9a6c4d2006adc500884f0593d31db2e81c48cc2bde151605a4e30e79a49530f0114f4bf

data/.gitignore

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

data/.travis.yml

@@ -1,23 +1,13 @@
-sudo: false
 language: ruby
-before_install: gem install bundler -v 1.17.1
-matrix:
-  include:
-    - gemfile: graphql-1.7.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_7 CI=true
-      rvm: 2.3.8
-    - gemfile: graphql-1.8.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_8 CI=true
-      rvm: 2.3.8
-    - gemfile: graphql-1.7.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_7 CI=true
-      rvm: 2.4.5
-    - gemfile: graphql-1.8.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_8 CI=true
-      rvm: 2.4.5
-    - gemfile: graphql-1.7.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_7 CI=true
-      rvm: 2.5.3
-    - gemfile: graphql-1.8.gemfile
-      env: GRAPHQL_RUBY_VERSION=1_8 CI=true
-      rvm: 2.5.3
+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

data/CHANGELOG.md

@@ -8,10 +8,56 @@ 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.2.2...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v2.0.0...HEAD)
 
 * WIP
 
+#### [v2.0.0](https://github.com/exAspArk/batch-loader/compare/v1.5.0...v2.0.0)
+
+* `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)
+
+* `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)
+
+Please use `BatchLoader::GraphQL.for` instead:
+
+```rb
+field :user, UserType, null: false
+
+def user # resolver
+  BatchLoader::GraphQL.for...
+end
+```
+
+Or wrap a BatchLoader instance with `BatchLoader::GraphQL.wrap`:
+
+```rb
+field :user, UserType, null: false
+
+def user # resolver
+  BatchLoader::GraphQL.wrap(lazy_user)
+end
+
+def lazy_user
+  BatchLoader.for...
+end
+```
+
+#### [v1.4.1](https://github.com/exAspArk/batch-loader/compare/v1.4.0...v1.4.1)
+
+* `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)
+
+* `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)
+
+* `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)
 
 * `Fixed`: Identify item by `key` object instead of `key` string representation. [#27](https://github.com/exAspArk/batch-loader/pull/27)

data/README.md

@@ -8,6 +8,20 @@
 
 This gem provides a generic lazy batching mechanism to avoid N+1 DB queries, HTTP queries, etc.
 
+Developers from these companies use `BatchLoader`:
+
+<a href="https://about.gitlab.com/"><img src="images/gitlab.png" height="35" width="114" alt="GitLab" style="max-width:100%;"></a>
+<img src="images/space.png" height="35" width="10" alt="" style="max-width:100%;">
+<a href="https://www.netflix.com/"><img src="images/netflix.png" height="35" width="110" alt="Netflix" style="max-width:100%;"></a>
+<img src="images/space.png" height="35" width="10" alt="" style="max-width:100%;">
+<a href="https://www.alibaba.com/"><img src="images/alibaba.png" height="35" width="86" alt="Alibaba" style="max-width:100%;"></a>
+<img src="images/space.png" height="35" width="10" alt="" style="max-width:100%;">
+<a href="https://www.universe.com/"><img src="images/universe.png" height="35" width="137" alt="Universe" style="max-width:100%;"></a>
+<img src="images/space.png" height="35" width="10" alt="" style="max-width:100%;">
+<a href="https://www.wealthsimple.com/"><img src="images/wealthsimple.png" height="35" width="150" alt="Wealthsimple" style="max-width:100%;"></a>
+<img src="images/space.png" height="35" width="10" alt="" style="max-width:100%;">
+<a href="https://decidim.org/"><img src="images/decidim.png" height="35" width="94" alt="Decidim" style="max-width:100%;"></a>
+
 ## Contents
 
 * [Highlights](#highlights)
@@ -20,8 +34,10 @@ This gem provides a generic lazy batching mechanism to avoid N+1 DB queries, HTT
   * [Loading multiple items](#loading-multiple-items)
   * [Batch key](#batch-key)
   * [Caching](#caching)
+  * [Replacing methods](#replacing-methods)
 * [Installation](#installation)
 * [API](#api)
+* [Related tools](#related-tools)
 * [Implementation details](#implementation-details)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -29,10 +45,6 @@ This gem provides a generic lazy batching mechanism to avoid N+1 DB queries, HTT
 * [License](#license)
 * [Code of Conduct](#code-of-conduct)
 
-<a href="https://www.universe.com/" target="_blank" rel="noopener noreferrer">
-  <img src="images/universe.png" height="41" width="153" alt="Sponsored by Universe" style="max-width:100%;">
-</a>
-
 ## Highlights
 
 * Generic utility to avoid N+1 DB queries, HTTP requests, etc.
@@ -223,23 +235,38 @@ Batching is particularly useful with GraphQL. Using such techniques as preloadin
 Let's take a look at the simple [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) schema example:
 
 ```ruby
-Schema = GraphQL::Schema.define do
-  query QueryType
+class MyProjectSchema < GraphQL::Schema
+  query Types::QueryType
 end
 
-QueryType = GraphQL::ObjectType.define do
-  name "Query"
-  field :posts, !types[PostType], resolve: ->(obj, args, ctx) { Post.all }
+module Types
+  class QueryType < Types::BaseObject
+    field :posts, [PostType], null: false
+
+    def posts
+      Post.all
+    end
+  end
 end
 
-PostType = GraphQL::ObjectType.define do
-  name "Post"
-  field :user, !UserType, resolve: ->(post, args, ctx) { post.user } # N+1 queries
+module Types
+  class PostType < Types::BaseObject
+    name "Post"
+
+    field :user, UserType, null: false
+
+    def user
+      post.user # N+1 queries
+    end
+  end
 end
 
-UserType = GraphQL::ObjectType.define do
-  name "User"
-  field :name, !types.String
+module Types
+  class UserType < Types::BaseObject
+    name "User"
+
+    field :name, String, null: false
+  end
 end
 ```
 
@@ -255,17 +282,22 @@ query = "
   }
 }
 "
-Schema.execute(query)
+MyProjectSchema.execute(query)
 ```
 
-To avoid this problem, all we have to do is to change the resolver to return `BatchLoader`:
+To avoid this problem, all we have to do is to change the resolver to return `BatchLoader::GraphQL` ([#32](https://github.com/exAspArk/batch-loader/pull/32) explains why not just `BatchLoader`):
 
 ```ruby
-PostType = GraphQL::ObjectType.define do
-  name "Post"
-  field :user, !UserType, resolve: ->(post, args, ctx) do
-    BatchLoader.for(post.user_id).batch do |user_ids, loader|
-      User.where(id: user_ids).each { |user| loader.call(user.id, user) }
+module Types
+  class PostType < Types::BaseObject
+    name "Post"
+
+    field :user, UserType, null: false
+
+    def user
+      BatchLoader::GraphQL.for(post.user_id).batch do |user_ids, loader|
+        User.where(id: user_ids).each { |user| loader.call(user.id, user) }
+      end
     end
   end
 end
@@ -274,8 +306,8 @@ end
 And setup GraphQL to use the built-in `lazy_resolve` method:
 
 ```ruby
-Schema = GraphQL::Schema.define do
-  query QueryType
+class MyProjectSchema < GraphQL::Schema
+  query Types::QueryType
   use BatchLoader::GraphQL
 end
 ```
@@ -292,7 +324,7 @@ BatchLoader.for(post.user_id).batch(default_value: NullUser.new) do |user_ids, l
 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:
+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 (`has_many`) relationships:
 
 ```ruby
 BatchLoader.for(user.id).batch(default_value: []) do |user_ids, loader|
@@ -314,7 +346,7 @@ def lazy_association(post)
 
   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) }
+    model.where(id: ids).each { |record| loader.call(record.id, record) }
   end
 end
 post1 = Post.save(association_id: 1, association_type: 'Tag')
@@ -374,6 +406,21 @@ puts user_lazy(1) # SELECT * FROM users WHERE id IN (1)
 puts user_lazy(1) # SELECT * FROM users WHERE id IN (1)
 ```
 
+If you set `cache: false`, it's likely you also want `replace_methods: false` (see below section).
+
+### Replacing methods
+
+By default, `BatchLoader` replaces methods on its instance by calling `#define_method` after batching to copy methods from the loaded value.
+This consumes some time but allows to speed up any future method calls on the instance.
+In some cases, when there are a lot of instances with a huge number of defined methods, this initial process of replacing the methods can be slow.
+You may consider avoiding the "up front payment" and "pay as you go" with `#method_missing` by disabling the method replacement:
+
+```ruby
+BatchLoader.for(id).batch(replace_methods: false) do |ids, loader|
+  # ...
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -393,20 +440,38 @@ Or install it yourself as:
 ## API
 
 ```ruby
-BatchLoader.for(item).batch(default_value: default_value, cache: cache, key: key) do |items, loader, args|
+BatchLoader.for(item).batch(
+  default_value: default_value,
+  cache: cache,
+  replace_methods: replace_methods,
+  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.                       |
+| 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.                           |
+| `replace_methods` | `true`                                                               | Set `false` to use `#method_missing` instead of replacing the methods after batching. |
+| `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, replace_methods: true, key: nil}` | Arguments passed to the `batch` method.                                               |
+
+## Related tools
+
+These gems are built by using `BatchLoader`:
+
+* [decidim-core](https://github.com/decidim/decidim/) – participatory democracy framework made with Ruby on Rails.
+* [ams_lazy_relationships](https://github.com/Bajena/ams_lazy_relationships/) – ActiveModel Serializers add-on for eliminating N+1 queries.
+* [batch-loader-active-record](https://github.com/mathieul/batch-loader-active-record/) – ActiveRecord lazy association generator to avoid N+1 DB queries.
+
+`BatchLoader` in other programming languages:
+
+* [batch_loader](https://github.com/exaspark/batch_loader) - Elixir implementation.
 
 ## Implementation details
 

data/batch-loader.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1.0' # keyword args
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.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-1.7.gemfile → graphql-latest.gemfile}

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

data/lib/batch_loader.rb

@@ -23,11 +23,13 @@ class BatchLoader
     @__executor_proxy = executor_proxy
   end
 
-  def batch(default_value: nil, cache: true, key: nil, &batch_block)
+  def batch(default_value: nil, cache: true, replace_methods: nil, key: nil, &batch_block)
     @default_value = default_value
     @cache = cache
+    @replace_methods = replace_methods.nil? ? cache : replace_methods
     @key = key
     @batch_block = batch_block
+
     __executor_proxy.add(item: @item)
 
     __singleton_class.class_eval { undef_method(:batch) }
@@ -74,7 +76,7 @@ class BatchLoader
   def __sync!
     loaded_value = __sync
 
-    if @cache
+    if @replace_methods
       __replace_with!(loaded_value)
     else
       loaded_value
@@ -86,7 +88,7 @@ class BatchLoader
 
     items = __executor_proxy.list_items
     loader = __loader
-    args = {default_value: @default_value, cache: @cache, key: @key}
+    args = {default_value: @default_value, cache: @cache, replace_methods: @replace_methods, key: @key}
     @batch_block.call(items, loader, args)
     items.each do |item|
       next if __executor_proxy.value_loaded?(item: item)

data/lib/batch_loader/executor_proxy.rb

@@ -18,7 +18,7 @@ class BatchLoader
     end
 
     def list_items
-      items_to_load.to_a
+      items_to_load.to_a.freeze
     end
 
     def delete(items:)

data/lib/batch_loader/graphql.rb

@@ -2,29 +2,65 @@
 
 class BatchLoader
   class GraphQL
-    class Wrapper
-      def initialize(batch_loader)
-        @batch_loader = batch_loader
-      end
+    def self.use(schema_definition)
+      schema_definition.lazy_resolve(BatchLoader::GraphQL, :sync)
 
-      def sync
-        @batch_loader.__sync
+      # in cases when BatchLoader is being used instead of BatchLoader::GraphQL
+      if schema_definition.respond_to?(:interpreter?) && schema_definition.interpreter?
+        schema_definition.tracer(self)
+      else
+        schema_definition.instrument(:field, self)
       end
     end
 
-    def self.use(schema_definition)
-      schema_definition.lazy_resolve(BatchLoader::GraphQL::Wrapper, :sync)
-      schema_definition.instrument(:field, self)
+    def self.trace(event, _data)
+      if event == 'execute_field'
+        result = yield
+        result.respond_to?(:__sync) ? wrap_with_warning(result) : result
+      else
+        yield
+      end
     end
 
     def self.instrument(type, field)
       old_resolve_proc = field.resolve_proc
       new_resolve_proc = ->(object, arguments, context) do
         result = old_resolve_proc.call(object, arguments, context)
-        result.respond_to?(:__sync) ? BatchLoader::GraphQL::Wrapper.new(result) : result
+        result.respond_to?(:__sync) ? wrap_with_warning(result) : result
       end
 
       field.redefine { resolve(new_resolve_proc) }
     end
+
+    def self.wrap_with_warning(batch_loader)
+      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|
+        graphql.batch_loader = batch_loader
+      end
+    end
+
+    def self.for(item)
+      new(item)
+    end
+
+    attr_writer :batch_loader
+
+    def initialize(item = nil)
+      @batch_loader = BatchLoader.for(item)
+    end
+
+    def batch(*kwargs, &block)
+      @batch_loader.batch(*kwargs, &block)
+      self
+    end
+
+    def sync
+      @batch_loader.__sync
+    end
   end
 end

data/lib/batch_loader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch-loader
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - exAspArk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -127,8 +127,7 @@ files:
 - batch-loader.gemspec
 - bin/console
 - bin/setup
-- graphql-1.7.gemfile
-- graphql-1.8.gemfile
+- graphql-latest.gemfile
 - lib/batch-loader.rb
 - lib/batch_loader.rb
 - lib/batch_loader/executor.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,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Powerful tool to avoid N+1 DB or HTTP queries
 test_files: []

data/graphql-1.8.gemfile

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