graphql-sources 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91917cfffbb3f024443e890da6294499029638a4673e9ef96d1b061117356016
-  data.tar.gz: 5f27027876a07800b499a9cd22832707e0b2fdb74778896d3b8b53693ce3df17
+  metadata.gz: fea99d5034323ff95b35a9d8e8d9ef4f549c36972c66f2958767c804a733c34a
+  data.tar.gz: db5ccdc4cabf4d10118e9572ebc88ccff7acf6837f333356db49a2ae5d626ddb
 SHA512:
-  metadata.gz: 61889bbe42856b8d18e11bf3cd0dbb3f8eeea81e979f97b79f5f8334083636514637746db0d064caa2e4db45eaefbfe3af842361f0f03c436f59f3f70a40bdc0
-  data.tar.gz: 932074f604d8490897ef8868e0f8562e04c715a3c0e89f670682f245644b25513743146c8e22d2ca35fbe969f79035485269a12c31914fbe69c6f19419beb39d
+  metadata.gz: 17b6e588ca2f514000c7ee9e3d1ace997b44bdb8ef43049611bf86d86711f1619bf65aa9c26305b33e00a05883a6873ed68902e7e06fcf8c223adad54787caa5
+  data.tar.gz: a66bd4b062d28915d1df9e904877a317ea5cc80f9cac6cbb7a3104503575220d2fce6730551c05f6421dfeb34ee62f8853824379f000d689b88d908a54f86f8f

data/README.md

@@ -21,147 +21,138 @@ end
 
 ## Usage
 
-### Loading `has_and_belongs_to_many` Associations
+### Loading `belongs_to` / `has_many` Associations
 
 ```ruby
-class Student
-  has_and_belongs_to_many :courses
+class Purchase < ActiveRecord::Base
+  belongs_to :customer
 end
 ```
 
 ```ruby
-class Course
-  has_and_belongs_to_many :students
+class Customer < ActiveRecord::Base
+  has_many :purchases
 end
 ```
 
 ```ruby
-class StudentType < GraphQL::Schema::Object
-  field :courses, [CourseType], null: false
+class PurchaseType < GraphQL::Schema::Object
+  field :customer, CustomerType, null: false
 
-  # @return [Array<Course>]
-  def courses
-    # SELECT "courses_students".* FROM "courses_students" WHERE "courses_students"."student_id" = IN (...)
-    # SELECT "courses".* FROM "courses" WHERE "courses"."id" IN (...)
+  # @return [Customer]
+  def customer
+    # SELECT * FROM "customers" WHERE "customers"."id" IN (...)
     dataloader
-      .with(GraphQL::Sources::ActiveRecordAssociation, :courses)
+      .with(GraphQL::Sources::ActiveRecordAssociation, :customer)
       .load(object)
   end
 end
 ```
 
 ```ruby
-class CourseType < GraphQL::Schema::Object
-  field :students, [StudentType], null: false
+class CustomerType < GraphQL::Schema::Object
+  field :purchases, [PurchaseType], null: false
 
-  # @return [Array<Student>]
-  def students
-    # SELECT "courses_students".\* FROM "courses_students" WHERE "courses_students"."course_id" = IN (...)
-    # SELECT "students".\* FROM "students" WHERE "students"."id" IN (...)
+  def purchases
+    # SELECT * FROM "customers" WHERE "customers"."id" IN (...)
     dataloader
-      .with(GraphQL::Sources::ActiveRecordAssociation, :students)
+      .with(GraphQL::Sources::ActiveRecordAssociation, :purchases)
       .load(object)
   end
 end
 ```
 
-### Loading `belongs_to` Associations
+### Loading `belongs_to` / `has_one` Associations
 
 ```ruby
-class Purchase < ActiveRecord::Base
-  belongs_to :visitor
+class Profile < ActiveRecord::Base
+  belongs_to :user
 end
 ```
 
 ```ruby
-class Customer < ActiveRecord::Base
-  has_many :purchases
+class User < ActiveRecord::Base
+  has_one :profile
 end
 ```
 
 ```ruby
-class PurchaseType < GraphQL::Schema::Object
-  field :customer, [CustomerType], null: false
+class ProfileType < GraphQL::Schema::Object
+  field :user, [UserType], null: false
 
-  def customer
+  # @return [User]
+  def user
+    # SELECT * FROM "users" WHERE "users"."id" IN (...)
     dataloader
-      .with(GraphQL::Sources::ActiveRecordObject, ::Profile, key: :id)
-      .load(object.customer_id)
+      .with(GraphQL::Sources::ActiveRecordAssociation, :user)
+      .load(object)
   end
 end
 ```
 
-### Loading `has_one` Associations
-
-```ruby
-class Profile < ActiveRecord::Base
-  belongs_to :user
-end
-```
-
-```ruby
-class User < ActiveRecord::Base
-  has_one :profile
-end
-```
-
 ```ruby
 class UserType < GraphQL::Schema::Object
   field :profile, [ProfileType], null: false
 
+  # @return [Profile]
   def profile
+      # SELECT * FROM "profiles" WHERE "profiles"."id" IN (...)
     dataloader
-      .with(GraphQL::Sources::ActiveRecordObject, ::Profile, key: :user_id)
-      .load(object.id)
+      .with(GraphQL::Sources::ActiveRecordAssociation, :profile)
+      .load(object)
   end
 end
 ```
 
-```sql
-SELECT "profiles".*
-FROM "profiles"
-WHERE "profiles"."user_id" IN (...)
-ORDER BY "profiles"."id"
-```
-
-### Loading `has_many` Associations
+### Loading `has_and_belongs_to_many` Associations
 
 ```ruby
-class User
-  has_many :comments
+class Student
+  has_and_belongs_to_many :courses
 end
 ```
 
 ```ruby
-class Comment
-  belongs_to :user
+class Course
+  has_and_belongs_to_many :students
 end
 ```
 
 ```ruby
-class UserType < GraphQL::Schema::Object
-  field :comments, [CommentType], null: false
+class StudentType < GraphQL::Schema::Object
+  field :courses, [CourseType], null: false
 
-  def comments
+  # @return [Array<Course>]
+  def courses
+    # SELECT * FROM "courses_students" WHERE "courses_students"."student_id" = IN (...)
+    # SELECT * FROM "courses" WHERE "courses"."id" IN (...)
     dataloader
-      .with(GraphQL::Sources::ActiveRecordCollection, ::Comment, key: :user_id)
-      .load(object.id)
+      .with(GraphQL::Sources::ActiveRecordAssociation, :courses)
+      .load(object)
   end
 end
 ```
 
-```sql
-SELECT "comments".*
-FROM "comments"
-WHERE "comments"."user_id" IN (...)
-ORDER BY "comments"."id"
+```ruby
+class CourseType < GraphQL::Schema::Object
+  field :students, [StudentType], null: false
+
+  # @return [Array<Student>]
+  def students
+    # SELECT * FROM "courses_students" WHERE "courses_students"."course_id" = IN (...)
+    # SELECT * FROM "students" WHERE "students"."id" IN (...)
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordAssociation, :students)
+      .load(object)
+  end
+end
 ```
 
 ### Loading `has_one_attached` Associations
 
 ```ruby
 class User
-  has_one_attached :avatar
+  has_one_attached :photo
 end
 ```
 
@@ -169,7 +160,13 @@ end
 class UserType < GraphQL::Schema::Object
   field :avatar, AttachedType, null: false
 
+  # @return [ActiveStorage::Attachment]
   def avatar
+    # SELECT "active_storage_attachments".*
+    # FROM "active_storage_attachments"
+    # WHERE "active_storage_attachments"."name" = 'avatar'
+    #   AND "active_storage_attachments"."record_type" = 'User'
+    #   AND "active_storage_attachments"."record_id" IN (...)
     dataloader
       .with(GraphQL::Sources::ActiveStorageHasOneAttached, :avatar)
       .load(object)
@@ -189,7 +186,13 @@ end
 class UserType < GraphQL::Schema::Object
   field :photos, [AttachedType], null: false
 
+  # @return [Array<ActiveStorage::Attachment>]
   def photos
+    # SELECT "active_storage_attachments".*
+    # FROM "active_storage_attachments"
+    # WHERE "active_storage_attachments"."name" = 'photos'
+    #   AND "active_storage_attachments"."record_type" = 'User'
+    #   AND "active_storage_attachments"."record_id" IN (...)
     dataloader
       .with(GraphQL::Sources::ActiveStorageHasManyAttached, :photos)
       .load(object)
@@ -197,6 +200,47 @@ class UserType < GraphQL::Schema::Object
 end
 ```
 
+### Loading ActiveRecord Object / ActiveRecord Collection
+
+```ruby
+class Event < ActiveRecord::Base
+  belongs_to :device
+end
+```
+
+```ruby
+class Device < ActiveRecord::Base
+  has_many :events
+end
+```
+
+```ruby
+class EventType < GraphQL::Schema::Object
+  field :device, DeviceType, null: false
+
+  # @return [Device]
+  def device
+    # SELECT * FROM "devices" WHERE "devices"."id" IN (...)
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordObject, ::Device, key: :id)
+      .load(object.device_id)
+  end
+end
+```
+
+```ruby
+class DeviceType < GraphQL::Schema::Object
+  field :events, [EventType], null: false
+
+  def events
+    # SELECT * FROM "events" WHERE "events"."device_id" IN (...)
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordCollection, ::Event, key: :device_id)
+      .load(object)
+  end
+end
+```
+
 ### Loading Counts
 
 ```ruby

data/lib/graphql/sources/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Sources
-    VERSION = '1.5.1'
+    VERSION = '1.5.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-sources
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Kevin Sylvestre