graphql-dataloader-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 102adb782dc39092fa0b88057c9e46f9d20c09f2a3c474acacc8c20117f828b7
+  data.tar.gz: 146a3a3729407a0df03ac98d50147520a56e0326673835e533bc8586093a7c52
+SHA512:
+  metadata.gz: 27b9a8e938c08665dd7a84e8e55d2ba9ea0476323c639fa0654a564779892fdb890127571348bdedcc9fb76dd75dd74e844c8da45c016173945fbe7ca9905cde
+  data.tar.gz: 1e71d74e869ca52da97b19a4907334bbb73e672799097a1ef322ccc8f6d8d07a4c62b9e784a5deb408dcf84a096c4cb112af65153ee475f35e927b16ab70efbe

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+  AllowedMethods: ['describe', 'context']
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-dataloader-activerecord.gemspec
+gemspec
+
+gem 'pry-byebug'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    graphql-dataloader-activerecord (0.1.0)
+      activerecord (>= 6.1)
+      activesupport (>= 6.1)
+      graphql (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    graphql (2.0.13)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  graphql-dataloader-activerecord!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  sqlite3
+
+BUNDLED WITH
+   2.3.14

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# graphql-dataloader-activerecord
+
+This gem provides proxy objects in place of ActiveRecord objects where the
+proxy handles relationship loading through GraphQL::Dataloader. This is an
+experimental approach which should theoretically allow authors to write GraphQL
+code that relies on ActiveRecord using regular ActiveRecord relationship
+methods without generating N+1 query situations.
+
+## Usage
+
+By including DataloaderRelationProxy::Lazy, your ActiveRecord-based type
+classes can transparently use efficient Dataloaders. For example, in the
+following example, N stories, and their authors can be authorized and loaded in
+a constant number of queries without changing the implementation of the types:
+
+```ruby
+class Query < GraphQL::Schema::Object
+  field :stories, ['Types::Story']
+
+  def stories
+    ::Story.all
+  end
+end
+
+class Story < GraphQL::Schema::Object
+  include DataloaderRelationProxy::Lazy
+
+  field :author, Types::User
+  field :text, String
+
+  def self.authorized?(object, context)
+    # Even though it looks like we're loading the author here, object.author is
+    # actually spawning a new fiber and yielding back to the GraphQL engine.
+    # The return value is also chainable so we can continue to efficiently follow
+    # ActiveRecord relationships as shown:
+    return false unless object.author.plan.name == 'paid'
+
+    # Arbitrary rule to force publication to load to demonstrate this
+    # functionality
+    return object.publication.present?
+  end
+
+  # There is no need to define an `author` method here since @object responds
+  # to `author` already, but if we did, it would be:
+  def author
+    @object.author
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Please begin by filling out the contributor form and asserting that
+
+> The code I'm contributing is mine, and I have the right to license it. I'm
+> granting you a license to distribute said code under the terms of this
+> agreement. at this page: https://opensource.dropbox.com/cla/
+
+Then create a new pull request through the github interface
+
+## License
+
+Copyright (c) 2022 Dropbox, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/dataloader_relation_proxy/active_record_object.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DataloaderRelationProxy
+  # Dataloader that loads ActiveRecord objects by an arbitrary key
+  class ActiveRecordObject < GraphQL::Dataloader::Source
+    def initialize(model_class, key = :id)
+      super()
+      @model_class = model_class
+      @key = key
+    end
+
+    def fetch(ids)
+      records = @model_class.where(@key => ids)
+      by_id = records.index_by { |record| record.send(@key) }
+      ids.map { |id| by_id[id] }
+    end
+  end
+end

data/lib/dataloader_relation_proxy/collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DataloaderRelationProxy
+  # Represents an ActiveRecord collection and provides an enumerable that
+  # returns underlying objects that are instances of
+  # DataloaderRelationProxy::Record
+  class Collection < Object
+    def initialize(object, dataloader)
+      @object = object
+      @dataloader = dataloader
+
+      # Need to ensure the collection elements are wrapped in
+      # DataloaderRelationProxy objects. I'm sure there's a nicer alternative.
+      #
+      # rubocop:disable Lint/NestedMethodDefinition
+      def @object.load_target
+        @association.load_target.map do |record|
+          DataloaderRelationProxy.for(record.class).new(record, @dataloader)
+        end
+      end
+      # rubocop:enable Lint/NestedMethodDefinition
+    end
+
+    def method_missing(method_name, *args, &block)
+      raise NoMethodError, "Missing method '#{method_name}' on #{@object}" unless @object.respond_to?(method_name)
+
+      result = @object.send(method_name, *args, &block)
+      if result.is_a?(ActiveRecord::Base)
+        DataloaderRelationProxy.for(result.class).new(result, @dataloader)
+      else
+        result
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      @object.respond_to?(method_name)
+    end
+
+    def loaded?
+      true
+    end
+  end
+end

data/lib/dataloader_relation_proxy/lazy.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DataloaderRelationProxy
+  # Including Lazy causes two changes for type classes.
+  #
+  # 1) Type.authorized? receives a relationship proxy object rather than the
+  #   actual object as its first parameter.
+  # 2) Type#rel is provided so that type instances can easily build and access
+  #   a relationship proxy.
+  #
+  # @see DataloaderRelationProxy for information about what benefits are
+  #   provided
+  module Lazy
+    extend ActiveSupport::Concern
+
+    # Prepended to type classes in order to change the authorized? interface
+    module Authorizer
+      def authorized?(object, context)
+        if object.is_a?(DataloaderRelationProxy)
+          super(object, context)
+        else
+          super(DataloaderRelationProxy.for(object.class).new(object, context.dataloader), context)
+        end
+      end
+    end
+
+    included do |parent|
+      parent.singleton_class.prepend(Authorizer)
+    end
+
+    def object
+      if @object.is_a?(DataloaderRelationProxy)
+        @object
+      else
+        DataloaderRelationProxy.for(@object.class).new(@object, context.dataloader)
+      end
+    end
+  end
+end

data/lib/dataloader_relation_proxy/record.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DataloaderRelationProxy
+  # Wraps ActiveRecord records and provides accessors for
+  # loading relationships via GraphQL::Dataloader
+  class Record < Object
+    delegate :to_param, to: :@object
+
+    def initialize(object, dataloader)
+      @object = object
+      @dataloader = dataloader
+    end
+
+    # Allows comparison with other wrappers or their underlying objects
+    #
+    # @param [DataloaderRelationProxy::Record] other wrapper or model instance
+    def ==(other)
+      if other.is_a?(DataloaderRelationProxy::Record)
+        comparator = other.instance_variable_get(:@object)
+      else
+        comparator = other
+      end
+
+      @object.send(:==, comparator)
+    end
+
+    def is_a?(thing)
+      super || @object.send(:is_a?, thing)
+    end
+
+    def loaded?
+      true
+    end
+  end
+end

data/lib/dataloader_relation_proxy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DataloaderRelationProxy
+  VERSION = '0.1.0'
+end

data/lib/dataloader_relation_proxy.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'graphql'
+require 'active_support/core_ext/module/delegation'
+require_relative 'dataloader_relation_proxy/collection'
+require_relative 'dataloader_relation_proxy/record'
+require_relative 'dataloader_relation_proxy/version'
+require_relative 'dataloader_relation_proxy/active_record_object'
+require_relative 'dataloader_relation_proxy/lazy'
+
+# Top level namespace for a system that proxies activerecord relationships
+# through GraphQL dataloaders.
+module DataloaderRelationProxy
+  # Namespace to house the proxy classes so they are easily addressable
+  Proxies = Module.new
+
+  Error = Class.new(StandardError)
+
+  DELEGATE_TO_MODEL_METHODS = %i[
+    ===
+    ==
+    eql?
+    equal?
+    <=>
+    <
+    >
+    <=
+    >=
+  ].freeze
+
+  @defined = Set.new
+
+  # Defines a wrapper class for the provided model. This wrapper creates
+  # classes that extend DataloaderRelationProxy::Record and then defines
+  # relationship accessors that are efficiently batched by GraphQL::Dataloader.
+  #
+  # @param [Class]
+  def self.define_for!(model)
+    @defined << model
+
+    # Recursively define the namespace and wrapper class
+    klass = model.name.split('::').reduce(Proxies) do |memo, value|
+      next memo.const_get(value, false) if memo.const_defined?(value, false)
+
+      memo.const_set(value, Class.new(DataloaderRelationProxy::Record))
+    end
+
+    define_belongs_to_accessors!(klass, model)
+    define_has_many_accessors!(klass, model)
+    delegate_class_methods!(klass, model)
+    catch_remaining_methods!(klass)
+  end
+
+  # Determine if there is already a wrapper class defined for the given model.
+  #
+  # @param [Class]
+  def self.defined_for?(model)
+    @defined.include?(model)
+  end
+
+  # Ensure a wrapper class is defined for the given model and return it.
+  #
+  # @param [Class]
+  def self.for(model)
+    define_for!(model) unless defined_for?(model)
+
+    DataloaderRelationProxy::Proxies.const_get(model.name, false)
+  end
+
+  # Given an activerecord model and wrapper class, define an accessor on the
+  # wrapper class for each belongs_to relationship on the model driven by
+  # GraphQL::Datalaoder.
+  #
+  # @param [DataloaderRelationProxy::Record] wrapper class to define
+  #   accessors
+  # @param [Class] underlying model
+  def self.define_belongs_to_accessors!(klass, model)
+    return unless model.respond_to?(:reflect_on_all_associations)
+
+    model.reflect_on_all_associations(:belongs_to).each do |reflection|
+      # not sure how to handle this yet
+      next if reflection.polymorphic?
+
+      self.for(reflection.klass)
+
+      klass.instance_eval do
+        DataloaderRelationProxy.activerecord_belongs_to(klass, reflection)
+      end
+    end
+  end
+
+  # Given an activerecord model and wrapper class, define an accessor on the
+  # wrapper class for each has_many relationship on the model driven by
+  # GraphQL::Datalaoder.
+  #
+  # @param [DataloaderRelationProxy::Record] wrapper class to define
+  #   accessors
+  # @param [Class] underlying model
+  def self.define_has_many_accessors!(klass, model)
+    return unless model.respond_to?(:reflect_on_all_associations)
+
+    model.reflect_on_all_associations(:has_many).each do |reflection|
+      # not sure how to handle this yet
+      next if reflection.polymorphic?
+
+      klass.instance_eval do
+        DataloaderRelationProxy.activerecord_has_many(klass, reflection)
+      end
+    end
+  end
+
+  # Delegates some class methods to the underlying model class so that
+  # instances of this proxy can more readily stand in for a model instance.
+  #
+  # @param [DataloaderRelationProxy::Record] proxy class
+  # @param [Class] underlying model
+  def self.delegate_class_methods!(klass, model)
+    DELEGATE_TO_MODEL_METHODS.each do |m|
+      klass.define_singleton_method(m) do |other|
+        model.send(m, other)
+      end
+    end
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def self.catch_remaining_methods!(klass)
+    klass.instance_eval do
+      define_method(:method_missing) do |method_name, *args, &block|
+        raise NoMethodError, "Missing method '#{method_name}' on #{@object}" unless @object.respond_to?(method_name)
+
+        self.class.instance_eval do
+          delegate method_name, to: :@object
+        end
+
+        @object.send(method_name, *args, &block)
+      end
+
+      define_method(:respond_to_missing?) do |method_name, include_private = false|
+        @object.respond_to?(method_name) || super(method_name, include_private)
+      end
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # Define a getter that works something like an ActiveRecord belongs_to
+  # relationship, except using a dataloader.
+  def self.activerecord_belongs_to(klass, reflection)
+    klass.define_method(reflection.name) do
+      instance = @dataloader.with(
+        ActiveRecordObject,
+        reflection.klass,
+        reflection.association_primary_key
+      ).load(@object.send(reflection.foreign_key))
+      return nil if instance.nil?
+
+      DataloaderRelationProxy.for(instance.class).new(instance, @dataloader)
+    end
+  end
+
+  # Define a getter that works something like an ActiveRecord has_many
+  # relationship, except using a dataloader.
+  def self.activerecord_has_many(klass, reflection)
+    klass.define_method(reflection.name) do
+      Collection.new(@object.send(reflection.name), @dataloader)
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: graphql-dataloader-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Crosby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  This gem provides proxy objects in place of ActiveRecord objects where the
+  proxy handles relationship loading through GraphQL::Dataloader. This is an
+  experimental approach which should theoretically allow authors to write GraphQL
+  code that relies on ActiveRecord using regular ActiveRecord relationship
+  methods without generating N+1 query situations.
+email:
+- stevecrozz@dropbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/dataloader_relation_proxy.rb
+- lib/dataloader_relation_proxy/active_record_object.rb
+- lib/dataloader_relation_proxy/collection.rb
+- lib/dataloader_relation_proxy/lazy.rb
+- lib/dataloader_relation_proxy/record.rb
+- lib/dataloader_relation_proxy/version.rb
+homepage: https://github.com/dropbox/graphql-dataloader-activerecord
+licenses: []
+metadata:
+  homepage_uri: https://github.com/dropbox/graphql-dataloader-activerecord
+  source_code_uri: https://github.com/dropbox/graphql-dataloader-activerecord
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Prevent ActiveRecord N+1 queries within GraphQL
+test_files: []