graphql-eager_load 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51028f140032e8b436a06fa19ad0d5fe1ad5e16ac2f0881acabaa3738e287bc
-  data.tar.gz: cb1cf7507e675e881699e679d6a9f248ce1a7bcd0697e6f1d90020325b1482cd
+  metadata.gz: c1f55715d1944da41fec7fd847f763d0ccf050171ec4549882ea960929d6a225
+  data.tar.gz: 6a7be6628e2a82112a28791a607bb4440fd940df7735ce786ed6c6d15b8a6587
 SHA512:
-  metadata.gz: 29058b322738f586de82e832722625fa5c1c09ce7716cc2377cfe30b1a7e0dbf21655221d9977135f683938241a1b2141632d6ded7affe4dd86e82c1db1c6ee0
-  data.tar.gz: 1ca0c090115b58c18bd01826c20f93c6019e53bba375ff970b3b8406223b16c2b2b4a3b57b1314620fbc099d692784924bc154dfd75a3f114c265cdc294b758a
+  metadata.gz: 1f3d89d38f9a040add5556cb2aa69bdeebb18004fdfc8e632cde8d1ed6e52dbb1fcc164a40a313ab37d945403502659f11411133b9920e942386c4a1c585e9b7
+  data.tar.gz: 839bcb503679904200af7cb0b1b397b8779c5d438ab5adb4e326354d779a0115e8476ad61b6bb961c4eaceb3dc70de627b9bb81c0991bbaa9530bbdb7e5e72ee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-eager_load (0.2.2)
+    graphql-eager_load (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -67,16 +67,16 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     graphql (1.11.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -84,16 +84,20 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
     nio4r (2.5.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -115,7 +119,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     railties (6.0.3.2)
       actionpack (= 6.0.3.2)
@@ -174,13 +178,13 @@ GEM
     sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -199,4 +203,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.11

data/README.md

@@ -1,7 +1,9 @@
 # Graphql::EagerLoad
 
-This gem traverses your graphql query looking for fields on types that match
-associations on those types. For each field found to be an association, this
+This gem assumes you are using [Rails](http://rubyonrails.org) and [ActiveRecord](https://guides.rubyonrails.org/active_record_querying.html). And that your GraphQL types and fields map as closely to your data model as possible. It uses those assumptions, or conventions, to handle N+1 prevention for you.
+
+It does so by traversing your graphql query looking for fields on types that match
+associations on those types' corresponding models. For each field found to be an association, this
 gem adds those associations to an [ActiveRecord::QueryMethods#includes](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-includes) hash. That hash can then be used to
 eager load the associations of records returned in your graphql resolver.
 
@@ -35,6 +37,64 @@ end
 
 The `.eager_load_model` and `#associations_to_eager_load` methods are provided by this gem.
 
+
+If your type defines a custom method for a field that maps to an ActiveRecord association, this gem will ignore that association and let your method handle it. If you still want to eager load the association in that case you need to let the gem know.
+
+```ruby
+module Types
+  class User < Types::Base
+    field :estimates, [Types::Estimate], null: false
+    field :profile_photo, Types::File, null: true
+    
+    def profile_photo
+      object.profile_photo if object.profile_photo.attached?
+    end
+    
+    def self.allow_include_builder_fields
+      [:profile_photo]
+    end
+  end
+end
+```
+
+Given this query: 
+
+```javascript
+users {
+  id
+  estimates {
+    id
+  }
+  profilePhoto {
+    redirectUrl
+    filename
+  }
+}
+```
+
+The output of the `#associations_to_eager_load` helper method would be `{estimates: {}, profile_photo: {blob: {}}`. Without the `.allow_include_builder_fields` class method the output would be `{estimates: {}}`.
+
+If you have a field that is derived from an association, but the association is not included in the query, you can define a `#custom_associations_for_fields` method to specify which associations to include for a specific field.
+
+```ruby
+module Types
+  class User < Types::Base
+    field :estimates, [Types::Estimate], null: false
+    field :org_names, [String], null: true
+    
+    def org_names
+      object.orgs.map(&:name)
+    end
+    
+    def self.custom_associations_for_fields
+      {
+        org_names: [:org]
+      }
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment.

data/lib/graphql/eager_load/builder.rb

@@ -42,6 +42,8 @@ module Graphql
           else
             includes.merge!(builder.includes)
           end
+
+          includes.deep_merge!(builder.custom_associations_for_selection)
         end
       end
 
@@ -66,6 +68,16 @@ module Graphql
         model.reflect_on_attachment(field_name).present?
       end
 
+      def custom_associations_for_selection
+        return {} unless field_owner.respond_to?(:custom_associations_for_fields)
+
+        custom_associations = field_owner.custom_associations_for_fields[field_name.to_sym]
+
+        return {} unless custom_associations
+
+        custom_associations.map { |association| [association, {}] }.to_h
+      end
+
       private
 
       attr_reader :selection, :model

data/lib/graphql/eager_load/resolver.rb

@@ -12,7 +12,7 @@ module Graphql
         graphql_eager_load_options(model: self.class.class_variable_get(:@@eager_load_model))
       end
 
-      def graphql_eager_load_options(selections: context.query.lookahead.selections, model:)
+      def graphql_eager_load_options(model:, selections: context.query.lookahead.selections)
         Builder.call(selections: selections, model: model)
       end
 

data/lib/graphql/eager_load/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module EagerLoad
-    VERSION = '0.2.2'
+    VERSION = '0.2.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-eager_load
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Elise Wood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.11
 signing_key: 
 specification_version: 4
 summary: Generate ActiveRecord eager loading options from GraphQL Queries.