graphql_activerecord_resolvers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f60bace7ac91068af1d90a02898469eab96572bd
-  data.tar.gz: 0ba1d470d3e34304bb2e007e0ec5c2a8ea40ac5f
+  metadata.gz: 1453e2c5f560747937e13eac3132dcd5a9d5f392
+  data.tar.gz: 7ca76ca633e8d515ac6127fb2d93beb4759ec8b4
 SHA512:
-  metadata.gz: 52137d2b8f781cc2c0c3200766ce6b726c6fc3fca6f7e2e1f21a4a312e3ca867a421654f2a8779abfa2f26a9baca127973813ebe1d854bb2b5a5a02eb62e7f3e
-  data.tar.gz: 7e3df25124d976177d4d38bd26c9eada577308182c10614c84d5e91de1b29e479d3d304857a12ccdc138fd9312f610357ffad2fae268f64834fa0c55801aaf9f
+  metadata.gz: 9c1ce9fb71907a0d8f0771a951e3286c01c4ac62f51cbea00f9b63c4965368a326e766c10155e984f8501ad1e5372d8e957f116714955083683b24eb092f5095
+  data.tar.gz: be1efe1931617776c429e9a1074e06092fe263bbf57c74c62cd3c9b51dc59f84d1c07e7cced809ccdf332d6be1cfabea3ab299b05deaa2a5e39f4ff9cf4bce25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_activerecord_resolvers (0.1.0)
+    graphql_activerecord_resolvers (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -21,7 +21,7 @@ GEM
     ast (2.3.0)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    graphql (0.19.4)
+    graphql (1.7.13)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
@@ -54,7 +54,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 5.1)
   bundler (~> 1.16)
-  graphql (~> 0.19)
+  graphql (~> 1.7)
   graphql_activerecord_resolvers!
   minitest (~> 5.0)
   pry (~> 0.11)

data/README.md

@@ -24,10 +24,11 @@ GraphQL marks a new era in API development, one in which the clients dictate wha
 should deliver. But, due to N+1 queries, using GraphQL with Rails is a pain. That's where this gem
 comes in.
 
-`graphql_activerecord_resolvers` works with [graphql-ruby](http://graphql-ruby.org/). It allows you
-to easily substitute your own resolvers for supercharged ones. These resolvers take a look at the
-schema, the query, and the context, and automatically build up an `eager_load` instruction that
-Rails understands.
+`graphql_activerecord_resolvers` works with the [graphql] gem. It provides an ActiveRecord scope
+that works in tandem with the GraphQL context to automatically preload the requested associations.
+This takes the database performance burden off of you when writing your GraphQL API.
+
+[graphql]: http://graphql-ruby.org
 
 To use it, simply make the following change to every **root field** in your Query:
 
@@ -39,32 +40,75 @@ module Types
     field :countries do
       type types[Types::CountryType]
 
--     resolve ->(obj, ctx, args) { Country.all }
-+     resolve GraphQLActiveRecordResolvers::BaseResolver.resolve(Country)
+-     resolve ->(_, _, _) { Country.all }
++     resolve ->(_, _, ctx) { Country.preload_graphql_associations(ctx) }
     end
 
     field :locations do
       type types[Types::LocationType]
 
--     resolve ->(obj, ctx, args) { Location.all }
-+     resolve GraphQLActiveRecordResolvers::BaseResolver.resolve(Location)
+-     resolve ->(_, _, _) { Location.all }
++     resolve ->(_, _, ctx) { Location.preload_graphql_associations(ctx) }
     end
   end
 end
 ```
 
-That's all you need to do.
+You'll notice the N+1's disappear.
+
+### When field names don't match association names
+
+There's a special case that the resolver can't detect automatically, and that is when you have a
+field that resolves to an association but does not match the name of said association. In this case,
+you need to explicitly declare the association name on the field. For example:
+
+```diff
+class Pet < ActiveRecord::Base
+  belongs_to :person
+end
+
+# ...
+
+module Types
+  PetType = GraphQL::ObjectType.define do
+    name "Pet"
+
+    field :owner do
+      type Types::PersonType
++     association_name :person
+      resolve -> (obj, _, _) { obj.person }
+    end
+  end
+end
+```
+
+### What about for fields that return single objects?
+
+Research is still underway on this. The difficulty lies in determining how resolvers would need to
+be modified to support eager-loading when requested, but also in such a way that redundant eager
+loading doesn't occur.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to
+[rubygems.org].
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+[rubygems.org]: https://rubygems.org
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/stevenpetryk/graphql_activerecord_resolvers.
+Bug reports and pull requests are welcome [on GitHub].
+
+[on GitHub]: https://github.com/stevenpetryk/graphql_activerecord_resolvers
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
+
+[MIT License]: https://opensource.org/licenses/MIT

data/graphql_activerecord_resolvers.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.11"
 
   spec.add_development_dependency "activerecord", "~> 5.1"
-  spec.add_development_dependency "graphql", "~> 0.19"
+  spec.add_development_dependency "graphql", "~> 1.7"
 end

data/lib/graphql_activerecord_resolvers.rb

@@ -1,7 +1,7 @@
-require "graphql_activerecord_resolvers/base_resolver"
-require "graphql_activerecord_resolvers/graphql_association"
+require "graphql_activerecord_resolvers/extensions"
+require "graphql_activerecord_resolvers/association"
+require "graphql_activerecord_resolvers/association_tree"
 require "graphql_activerecord_resolvers/version"
 
 module GraphQLActiveRecordResolvers
-  # Your code goes here...
 end

data/lib/graphql_activerecord_resolvers/association.rb

@@ -0,0 +1,63 @@
+module GraphQLActiveRecordResolvers
+  class Association
+    attr_reader :klass, :irep_node, :root
+
+    def initialize(klass:, irep_node:, root:)
+      @klass = klass
+      @irep_node = irep_node
+      @root = root
+    end
+
+    def build_includes_arguments
+      if root
+        child_associations.map(&:build_includes_arguments)
+      elsif child_associations.any?
+        {
+          irep_node_association_name => child_associations.map(&:build_includes_arguments),
+        }
+      else
+        irep_node_association_name
+      end
+    end
+
+    private
+
+    def child_irep_nodes_that_map_to_associations
+      irep_node.typed_children.values.first.select do |_, irep_node|
+        association_names.include?(irep_node_association_name(irep_node))
+      end.values
+    end
+
+    def child_associations
+      child_irep_nodes_that_map_to_associations.map do |child_irep_node|
+        Association.new(
+          klass: klass_for_child_irep_node(child_irep_node),
+          irep_node: child_irep_node,
+          root: false,
+        )
+      end
+    end
+
+    def field_for_irep_node(irep_node)
+      irep_node.definitions.first
+    end
+
+    def associations
+      klass.reflect_on_all_associations
+    end
+
+    def association_names
+      associations.map(&:name).map(&:to_s)
+    end
+
+    def irep_node_association_name(irep_node = self.irep_node)
+      field = field_for_irep_node(irep_node)
+      (field.metadata[:association_name] || field.name).to_s
+    end
+
+    def klass_for_child_irep_node(child_irep_node)
+      name = irep_node_association_name(child_irep_node)
+      associations.detect { |association| association.name.to_s == name }.klass
+    end
+  end
+end

data/lib/graphql_activerecord_resolvers/association_tree.rb

@@ -0,0 +1,21 @@
+module GraphQLActiveRecordResolvers
+  class AssociationTree
+    attr_reader :klass, :irep_node
+
+    def initialize(klass, ctx)
+      @klass = klass
+      @irep_node = ctx.irep_node
+    end
+
+    def includes_arguments
+      @includes_arguments ||=
+        Association.
+          new(
+            klass: klass,
+            irep_node: irep_node,
+            root: true,
+          ).
+          build_includes_arguments
+    end
+  end
+end

data/lib/graphql_activerecord_resolvers/extensions.rb

@@ -0,0 +1,15 @@
+require "active_record"
+require "graphql"
+
+module ActiveRecord
+  class Base
+    def self.preload_graphql_associations(ctx)
+      association_tree = GraphQLActiveRecordResolvers::IncludesTree.new(self, ctx)
+      includes(association_tree.includes_arguments)
+    end
+  end
+end
+
+GraphQL::Field.accepts_definitions(
+  association_name: GraphQL::Define.assign_metadata_key(:association_name),
+)

data/lib/graphql_activerecord_resolvers/version.rb

@@ -1,3 +1,3 @@
 module GraphQLActiveRecordResolvers
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_activerecord_resolvers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steven Petryk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.7'
 description: 
 email:
 - petryk.steven@gmail.com
@@ -126,8 +126,9 @@ files:
 - bin/setup
 - graphql_activerecord_resolvers.gemspec
 - lib/graphql_activerecord_resolvers.rb
-- lib/graphql_activerecord_resolvers/base_resolver.rb
-- lib/graphql_activerecord_resolvers/graphql_association.rb
+- lib/graphql_activerecord_resolvers/association.rb
+- lib/graphql_activerecord_resolvers/association_tree.rb
+- lib/graphql_activerecord_resolvers/extensions.rb
 - lib/graphql_activerecord_resolvers/version.rb
 homepage: https://github.com/stevenpetryk/graphql_activerecord_resolvers
 licenses:

data/lib/graphql_activerecord_resolvers/base_resolver.rb

@@ -1,57 +0,0 @@
-module GraphQLActiveRecordResolvers
-  class BaseResolver
-    attr_reader :ctx, :schema, :query
-
-    def self.resolve_collection(klass)
-      ->(_obj, _args, ctx) do
-        new(klass, ctx).resolve
-      end
-    end
-
-    def initialize(klass, ctx)
-      @klass = klass
-      @ctx = ctx
-      @schema = ctx.schema
-      @query = ctx.query
-    end
-
-    def resolve
-      if includes_tree
-        klass.includes(includes_tree)
-      else
-        klass.all
-      end
-    end
-
-    def includes_tree
-      @includes_tree ||=
-        GraphQLAssociation.
-          new(
-            schema: schema,
-            klass: klass,
-            field: root_field,
-            selections: root_selections,
-            root: true,
-          ).
-          build_includes_tree
-    end
-
-    private
-
-    def root_field
-      schema.query.get_field(ctx.key)
-    end
-
-    def root_selections
-      ctx.ast_node.selections
-    end
-
-    def klass
-      if @klass.is_a? String
-        @klass.constantize
-      else
-        @klass
-      end
-    end
-  end
-end

data/lib/graphql_activerecord_resolvers/graphql_association.rb

@@ -1,67 +0,0 @@
-module GraphQLActiveRecordResolvers
-  class GraphQLAssociation
-    attr_reader :klass, :schema, :field, :selections, :root
-
-    def initialize(schema:, klass:, field:, selections:, root:)
-      @klass = klass
-      @schema = schema
-      @field = field
-      @selections = selections
-      @root = root
-    end
-
-    def build_includes_tree
-      if root
-        child_associations.map(&:build_includes_tree)
-      elsif child_associations.any?
-        {
-          field.name => child_associations.map(&:build_includes_tree),
-        }
-      else
-        field.name
-      end
-    end
-
-    private
-
-    def child_fields
-      selections.map do |selection|
-        [selection, schema.get_field(field_type, selection.name)]
-      end
-    end
-
-    def child_fields_that_are_also_associations
-      child_fields.select do |_, field|
-        association_names.map(&:to_s).include?(field.name.to_s)
-      end
-    end
-
-    def child_associations
-      child_fields_that_are_also_associations.map do |(selection, field)|
-        GraphQLAssociation.new(
-          schema: schema,
-          klass: klass_for_association_name(field.name),
-          field: field,
-          selections: selection.selections,
-          root: false,
-        )
-      end
-    end
-
-    def field_type
-      field.type.unwrap
-    end
-
-    def associations
-      klass.reflect_on_all_associations
-    end
-
-    def association_names
-      associations.map(&:name)
-    end
-
-    def klass_for_association_name(name)
-      associations.detect { |association| association.name.to_s == name.to_s }.klass
-    end
-  end
-end