graphql-extras 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 798b3acf2885ab4505348ce82a903491dcf69f9bb938f6d14f6123f7e15e7828
-  data.tar.gz: f09ba6716261367885bb2d59a3cfc5d8795d37ad815f8f97b6531bbd4b9c650a
+  metadata.gz: 79aec0f7de63c3a1efa653093be5a38b2138e6887019f1cf2c7412117c423c51
+  data.tar.gz: 2e8bad4be442f7b922cec0583eea4ee4afd1976f3298823457b29720bb55d826
 SHA512:
-  metadata.gz: 9f10d3c82db22907b693d047e64f3e635eb178aa3397ff2ff3a905f19a16fa3e9ea4994497ecd33f113a814aacbbac1145c621096d8e3cc8dd682bf662b4ccdd
-  data.tar.gz: c6d548c8fcc787c40b1825bfdaa270d7e41a0d5c9077c29be9ce4720b715175a4a048e227874f5f9a4b3fcc27ef57f8a57d5ce59d8a47037e0f730b64a6412cb
+  metadata.gz: 5bd25a61e755ccdd182f786706ef5190e55979310f5c2cd602adbfa6d8b389e20a2c42e2e0e5c6838d592f9e957f55498a6a271404299e1e33112b1ec44e979d
+  data.tar.gz: 5e3d5b584e670997f1a430b631eff44abdd5fcb289cac51d3945ae58fc9440eaffadf3048ab5a180de94974b0560e83f3227faa223d594d309881d5ca52ec342

data/README.md

@@ -30,6 +30,34 @@ class GraphqlController < ApplicationController
 end
 ```
 
+### GraphQL::Extras::Batch::AssociationLoader
+
+This is a subclass of [`GraphQL::Batch::Loader`](https://github.com/Shopify/graphql-batch) that performs eager loading of Active Record associations.
+
+```ruby
+loader = GraphQL::Extras::Batch::AssociationLoader.for(:blog)
+loader.load(Post.first)
+loader.load_many(Post.all)
+```
+
+### GraphQL::Extras::Batch::Resolvers
+
+This includes a set of convenience methods for query batching.
+
+```ruby
+class Post < GraphQL::Schema::Object
+  include GraphQL::Extras::Batch::Resolver
+
+  field :blog, BlogType, resolve: association(:blog), null: false
+  field :comments, [CommentType], resolve: association(:comments, preload: { comments: :user }), null: false
+  field :blog_title, String, null: false
+
+  def blog_title
+    association(object, :blog).then(&:title)
+  end
+end
+```
+
 ### GraphQL::Extras::Types
 
 In your base classes, you should include the `GraphQL::Extras::Types`.

data/graphql-extras.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", "~> 5.2"
+  spec.add_dependency "graphql-batch", "~> 0.4"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -32,4 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "graphql", "~> 1.9"
   spec.add_development_dependency "rspec-rails", "~> 3.8"
   spec.add_development_dependency "actionpack", "~> 5.2"
+  spec.add_development_dependency "activerecord", "~> 5.2"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
 end

data/lib/graphql/extras.rb

@@ -1,6 +1,7 @@
 require "graphql/extras/version"
 require "graphql/extras/types"
 require "graphql/extras/controller"
+require "graphql/extras/batch"
 
 module GraphQL
   module Extras

data/lib/graphql/extras/batch.rb

@@ -0,0 +1,47 @@
+require "graphql/batch"
+
+module GraphQL
+  module Extras
+    module Batch
+      class AssociationLoader < GraphQL::Batch::Loader
+        def initialize(name, preload: name)
+          @name = name
+          @preload = preload
+        end
+
+        def cache_key(record)
+          record.object_id
+        end
+
+        def perform(records)
+          preloader = ActiveRecord::Associations::Preloader.new
+          preloader.preload(records, @preload)
+
+          records.each do |record|
+            fulfill(record, record.public_send(@name))
+          end
+        end
+      end
+
+      module Resolvers
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def association(name)
+            lambda do |record, _args, _ctx|
+              loader = AssociationLoader.for(name)
+              loader.load(record)
+            end
+          end
+        end
+
+        def association(record, name)
+          loader = AssociationLoader.for(name)
+          loader.load(record)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/extras/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Extras
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-extras
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ray Zane
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: A set of modules and types for buildign GraphQL APIs.
 email:
 - raymondzane@gmail.com
@@ -125,6 +167,7 @@ files:
 - bin/setup
 - graphql-extras.gemspec
 - lib/graphql/extras.rb
+- lib/graphql/extras/batch.rb
 - lib/graphql/extras/controller.rb
 - lib/graphql/extras/rspec.rb
 - lib/graphql/extras/types.rb