rgraphql_preload_ar 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cdbecb9b1ecb068e3f59310259382760a58eadf091da2f554f7730357cdfe1e
-  data.tar.gz: 9a31db9385e23ff3796f7e4ec6758b5f623e2adbb349547664b4c100380e7adb
+  metadata.gz: aa2fc79bc75107460d053ba16b6910754a539be5eefa0c5273da0f3d45dc2526
+  data.tar.gz: 02deba4fd7f8afb67a0e84c6889094e0d71c1b14c308107a250d63eef5d2b02a
 SHA512:
-  metadata.gz: b76b4e3c2d94f4a11256b47473074aa46192173aac94d8c05ca463ee63f85c7df70f664f5c07252794b0df8035f0f5446890386ffe4bb13f2c2bad3264f66495
-  data.tar.gz: 2aece3c7fbc039c575858d04835b738436719cc7c6375dfaafcde27ffde7eab7aa18f7a705a63bbfb4aa3cbbd160c7b4d0ac532966ce317680a50f2183fd3e79
+  metadata.gz: 116f582a484dbd1e3452a94b9790f9b5bbbfdfe39d5fd0ed52cde8b7e0a700cb9c70ef73a0687206512d00950fa0900b559d605430567ba3e6a35c74f98bc697
+  data.tar.gz: 8db5cd99ad9564ae6283042f9b9b27e9ce00b49a8a941f471feccc51aaf2876dac5ee3295b96263e94ff805bb6b95e3b905b1a1cfbc62de6005f5979a34cc20f

data/README.md

@@ -0,0 +1,93 @@
+## What's this gem do
+
+preload ActiveRecord Associations when using graphql and ActiveRecord
+
+## Install
+
+`gem rgraphql_preload_ar`
+
+## Scene
+
+Your original code of resolver might look like this: 
+
+```ruby
+class Resolvers::ProfileResolver < GraphQL::Function
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    ctx[:current_user]
+  end
+end
+```
+
+If the query like this:
+```
+query{
+  profile{
+    id
+    works{
+      comments{
+        replyUser{
+          name
+        }
+        content
+      }
+      name
+      id
+      likes{
+        owner{
+          name
+          works{
+            name
+            likes{
+              owner{
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+    name
+  }
+}
+```
+
+It will cause Multi-level nested N + 1 problem.
+
+And you want to resolver it, you can write like this:
+
+```ruby
+class Resolvers::ProfileResolver < OptimizedFunction
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    User.includes([works: [comments: :reply_user, likes: [owner: [works: [likes: :owner]]]]]).find(ctx[:current_user].id)
+  end
+end
+```
+
+You will manually resolve N + 1 problem in every resolver.Worse, even if only one field is used, you need to request all the tables included.
+
+## Usage
+
+Your Resolver inherits from `OptimizedFunction` instead of `GraphQL::Function`.
+Defining `_call` method instead of `call`
+Using `includes_klass(your_model_name)` instead of your original includes statement.
+
+
+```ruby
+class Resolvers::ProfileResolver < OptimizedFunction
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    includes_kclass(User).find(ctx[:current_user].id)
+  end
+end
+```

data/lib/optimized_function.rb

@@ -33,6 +33,7 @@ class OptimizedFunction < GraphQL::Function
     tree.each do |k, v|
       if v.present? && klass.reflect_on_all_associations.map(&:name).include?(k)
         result_tree[k.to_sym] = {}
+        next if klass.reflections[k.to_s].options[:polymorphic]
         _klass = klass.reflections[k.to_s].class_name.constantize
         gen_result_tree _klass, tree[k], result_tree[k.to_sym]
       end

data/rgraphql_preload_ar.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rgraphql_preload_ar'
-  s.version = "1.0.2"
+  s.version = "1.0.3"
   s.date = Time.now.strftime("%Y-%m-%d")
   s.summary = %q{rails graphql preload ar in resolver}
   s.files = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgraphql_preload_ar
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - tinyfeng.hou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -34,6 +34,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- README.md
 - lib/optimized_function.rb
 - lib/rgraphql_preload_ar.rb
 - rgraphql_preload_ar.gemspec