graphql-active_record_batcher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 987cfab30dfdc3481d7feff6ffe29273ed8de21c
-  data.tar.gz: 067a21a5f99cb3f68e6b1084a685e8839a82e442
+  metadata.gz: ee2c32fbd0c4746914bd2991fc4f48120c0ebde7
+  data.tar.gz: eb39eeef4dcef1422f84aff5771ee7c28b3277a8
 SHA512:
-  metadata.gz: 3f68ca34876e1ef67ce416b428fafb11b648388b68e5c36d4f017163ebe5cd82482822014accc07bd77a981e6c873975b7b20e8c6a8f7560b55b85e3007b16f7
-  data.tar.gz: b536f7dc3d2ccb195ebc70e66fcf4326185236acebcf057c2dfcef4770a464c7fa66b9ffe7d54b1ec7549f62125141f4c5a0007ce9139133ab55f4b5211e8b58
+  metadata.gz: 668f040a391588456525f11d27b6dcfe478fd94cef5bc30950e27076bbb369dbd6f5ae611fe5b0ecf956c63d78c873a9b353e71c348d40906a2fea5be31ed00a
+  data.tar.gz: 4245d86955ae7d93fe41cc5ff70f434b191e9a7c7b0311173b0a96b12fb0a1de83e103cfaad96f7dcf96e5b558659c51a6b31abccdd6c358d334854cb4b7f5ec

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+*.db
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/README.md

@@ -24,6 +24,17 @@ Or install it yourself as:
 
 ## Usage
 
+### Set up preloading for a Schema
+
+```ruby
+Schema = GraphQL::Schema.define do
+  # Enable preloading on a per-schema basis
+  use_preloading
+  query Query
+  mutation Mutation
+end
+```
+
 ### Preloading Associations
 
 Using GraphQL without preloading associations results in under performant API and
@@ -64,8 +75,8 @@ StarWarsMovie = GraphQL::ObjectType.define do
   # the parent object
   model Movie
 
-  field :characters, !types[!Dog] do
-    preloads(:characters)
+  field :characters, !types[!Character] do
+    preloads :characters
     resolve ->(movie, _, _) { movie.characters }
   end
 end
@@ -79,20 +90,15 @@ Associations will now be preloaded and only 3 queries are used this time:
 3: SELECT   "characters".* FROM "characters" WHERE "characters"."movie_d" IN (1, 2)
 ```
 
-### Schema config
+#### Preload multiple associations
 
-```ruby
-Schema = GraphQL::Schema.define do
-  query Query
-  mutation Mutation
-
-  # GraphQL Batch setup. Handle Promise objects.
-  lazy_resolve(Promise, :sync)
-  instrument(:query, GraphQL::Batch::Setup)
+If a certain call loads more than one association, you can use an
+array to express the ones to preload.
 
-  # FieldInstrumenter takes care of preloading assocations you've
-  # marked using the `preloads` attribute
-  instrument(:field, GraphQL::ActiveRecordBatcher::FieldInstrumenter.new)
+```ruby
+field :characters, !types[!Character] do
+  preloads [:characters, :planets]
+  resolve ->(movie, _, _) { movie.characters }
 end
 ```
 
@@ -100,7 +106,7 @@ end
 
   - [ ] Expose a way to batch finds
   - [ ] Expose a way or documentation on how to batch the `node` field
-  - [ ] Accept an array of preloads
+  - [x] Accept an array of preloads
   - [ ] Accept nested preloads
 
 ## License

data/lib/graphql/active_record_batcher.rb

@@ -7,5 +7,15 @@ module GraphQL
   end
 end
 
+# Accept a preloads attribute on fields
 GraphQL::Field.accepts_definitions(preloads: GraphQL::Define.assign_metadata_key(:preloads))
+
+# For association preloading we need to know which Mode we are dealing with
 GraphQL::ObjectType.accepts_definitions(model: GraphQL::Define.assign_metadata_key(:model))
+
+# A definition on schema lets us avoid documenting how to setup instrumenters
+GraphQL::Schema.accepts_definitions(use_preloading: ->(schema) {
+  schema.lazy_methods.set(Promise, :sync)
+  schema.instrument(:query, GraphQL::Batch::Setup)
+  schema.instrument(:field, GraphQL::ActiveRecordBatcher::FieldInstrumenter.new)
+})

data/lib/graphql/active_record_batcher/association_loader.rb

@@ -34,7 +34,9 @@ module GraphQL
       attr_reader :model, :association
 
       def association_loaded?(record)
-      record.association(@association).loaded?
+        puts record
+        puts @association
+        record.association(@association).loaded?
       end
     end
   end

data/lib/graphql/active_record_batcher/field_instrumenter.rb

@@ -2,9 +2,9 @@ module GraphQL
   module ActiveRecordBatcher
     class FieldInstrumenter
       def instrument(type, field)
-        association_to_preload = field.metadata[:preloads]
+        associations = field.metadata[:preloads]
 
-        if association_to_preload
+        if associations
           # Model is needed to preload an association
           unless model = type.metadata[:model]
             message = "No ActiveRecord Model set on type #{type.name}'s metadata."\
@@ -13,17 +13,14 @@ module GraphQL
           end
 
           # Make sure the association exists on the model
-          validate_preload(model, association_to_preload)
-
-          loader = GraphQL::ActiveRecordBatcher::AssociationLoader.new(
-            model,
-            association_to_preload
-          )
+          validate(model, associations)
 
           # "Wrap" the resolve proc with our own, which returns a promise
           old_resolve_proc = field.resolve_proc
           new_resolve_proc = ->(obj, args, ctx) do
-            loader.load(obj).then { old_resolve_proc.call(obj, args, ctx) }
+            build_preload_promise(obj, model, associations).then do
+              old_resolve_proc.call(obj, args, ctx)
+            end
           end
 
           field.redefine do
@@ -36,7 +33,36 @@ module GraphQL
 
       private
 
-      def validate_preload(model, association_to_preload)
+      def build_preload_promise(object, model, associations)
+        if associations.is_a?(Array)
+          Promise.all(associations.map do |association|
+            loader_for(model, association).load(object)
+          end)
+        else
+          loader_for(model, associations).load(object)
+        end
+      end
+
+      def loader_for(model, association)
+        GraphQL::ActiveRecordBatcher::AssociationLoader.for(
+          model,
+          association
+        )
+      end
+
+      def validate(model, associations)
+        case associations
+        when Symbol
+          validate_association(model, associations)
+        when Array
+          associations.each { |association| validate_association(model, association) }
+        else
+          raise ArgumentError, "Cannot preload associations #{associations}."\
+            "Use a Symbol to preload one association or an Array of Symbols to load many."
+        end
+      end
+
+      def validate_association(model, association_to_preload)
         unless model.reflect_on_association(association_to_preload)
           raise ArgumentError, "No association `#{association_to_preload}` on model `#{model}`"
         end

data/lib/graphql/active_record_batcher/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module ActiveRecordBatcher
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-active_record_batcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler