graphql-preload 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9cba006dfca0e52d2cbd40c5364594f358a3ac6
-  data.tar.gz: 3086dde1fc427ba144b721b9ae0d10cdca6f0f2d
+  metadata.gz: ba8ef1cfb79ea9620cb392101e7ba7157bd19082
+  data.tar.gz: 96f464f9f3534d0b46328036ffc4a68166037c4b
 SHA512:
-  metadata.gz: d1490ee109e5d08f0bd5c8a5d84ba29981487a0a7950942fbab89936272dbe73180e135406b748c297991381ea867fea8b5a5a2ac2d684e3ab29d8945562bc94
-  data.tar.gz: 7de182aa0dba1117bbfb15482e7a218407f4022bdc62d8336f1133cac9c2149d424be4fa43f35e23dcc4ccab28692a154ce4e0f6ff8c5e73ccdf3cffbc862122
+  metadata.gz: f9d0e48b413c217329464a1410394d6602a454d434ab7bca8898ce16fcdddbc635bdd07de12a68f2461357b5f60de82a655fdcb997337b62b0e832d1178739f4
+  data.tar.gz: e4e1738b221ce13f6e42c1841b752bbfa9b4e6d63308a3f6f93085fc9f55e2a8b09edd8f701192b7740e8ec6df7e26bc44a81772712a9c817edf6dc6d1c932c0

data/README.md

@@ -24,51 +24,57 @@ Or install it yourself as:
 
 First, enable preloading in your `GraphQL::Schema`:
 
-    Schema = GraphQL::Schema.define do
-      use GraphQL::Batch
+```ruby
+Schema = GraphQL::Schema.define do
+  use GraphQL::Batch
 
-      enable_preloading
-    end
+  enable_preloading
+end
+```
 
 Call `preload` when defining your field:
 
-    PostType = GraphQL::ObjectType.define do
-      name 'Post'
+```ruby
+PostType = GraphQL::ObjectType.define do
+  name 'Post'
 
-      field :comments, !types[!CommentType] do
-        # Post.includes(:comments)
-        preload :comments
+  field :comments, !types[!CommentType] do
+    # Post.includes(:comments)
+    preload :comments
 
-        # Post.includes(:comments, :authors)
-        preload [:comments, :authors]
+    # Post.includes(:comments, :authors)
+    preload [:comments, :authors]
 
-        # Post.includes(:comments, authors: [:followers, :posts])
-        preload [:comments, { authors: [:followers, :posts] }]
+    # Post.includes(:comments, authors: [:followers, :posts])
+    preload [:comments, { authors: [:followers, :posts] }]
 
-        resolve ->(obj, args, ctx) { obj.comments }
-      end
-    end
+    resolve ->(obj, args, ctx) { obj.comments }
+  end
+end
+```
 
 ### `preload_scope`
 Starting with Rails 4.1, you can scope your preloaded records by passing a valid scope to [`ActiveRecord::Associations::Preloader`](https://apidock.com/rails/v4.1.8/ActiveRecord/Associations/Preloader/preload). Scoping can improve performance by reducing the number of models to be instantiated and can help with certain business goals (e.g., only returning records that have not been soft deleted).
 
 This functionality is surfaced through the `preload_scope` option:
 
-    PostType = GraphQL::ObjectType.define do
-      name 'Post'
-
-      field :comments, !types[!CommentType] do
-        preload :comments
-        preload_scope ->(args, ctx) { Comment.where(deleted_at: nil) }
-
-        # Resolves with records returned from the following query:
-        # SELECT "comments".*
-        # FROM "comments"
-        # WHERE "comments"."deleted_at" IS NULL
-        #   AND "comments"."post_id" IN (1, 2, 3)
-        resolve ->(obj, args, ctx) { obj.comments }
-      end
-    end
+```ruby
+PostType = GraphQL::ObjectType.define do
+  name 'Post'
+
+  field :comments, !types[!CommentType] do
+    preload :comments
+    preload_scope ->(args, ctx) { Comment.where(deleted_at: nil) }
+
+    # Resolves with records returned from the following query:
+    # SELECT "comments".*
+    # FROM "comments"
+    # WHERE "comments"."deleted_at" IS NULL
+    #   AND "comments"."post_id" IN (1, 2, 3)
+    resolve ->(obj, args, ctx) { obj.comments }
+  end
+end
+```
 
 ## Development
 

data/lib/graphql/preload/loader.rb

@@ -39,7 +39,10 @@ module GraphQL
       end
 
       private def preload_scope
-        scope if scope.try(:klass) == model.reflect_on_association(association).klass
+        return nil unless scope
+        reflection = model.reflect_on_association(association)
+        raise ArgumentError, 'Cannot specify preload_scope for polymorphic associations' if reflection.polymorphic?
+        scope if scope.try(:klass) == reflection.klass
       end
 
       private def validate_association

data/lib/graphql/preload/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Preload
-    VERSION = '2.0.0'.freeze
+    VERSION = '2.0.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-preload
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Ryan Foster, Etienne Tripier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord