graphql-sources 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b83f8f866fbc38f5645d8887f0de9952e56126bdd0a48b0e2d5bca5099b4b110
-  data.tar.gz: bba362e0571ae8a9abdb344a6d17cb4894fac92a5d8f67ac7f556e0a336d6459
+  metadata.gz: 94b282ba84b9627d96828c4ebe8b73b609bcd61645bb67ee3894d7850fadbffb
+  data.tar.gz: e8aee59b0d9ad8cfe65dc2203b285ca6e174c7a2fa7dae1250bb9b3e015176eb
 SHA512:
-  metadata.gz: 696372d3f88a6db7d223c26ec3a27c77138a4473d03dc4285c8904f79271d2f044762133af5e7fa88c475c4ae2b035a66a4fa4caab699004b7dd2103ae9ce63a
-  data.tar.gz: 9f7014bd5a85a5c6f89e55da33f989f4939caf00411876d024f93cafa5b115e412668aa3cd8bb80a6cc168d4c9ababdc4484c340e1b772f8ed2a721ba2492c5a
+  metadata.gz: 6ada131108e0dc2a804eb6e35eedcfc1fc0d20fd259271109091761cdebeda39a20ff25677a3638300489b25480ab71b821e48ceca997ad5602a7414e7081416
+  data.tar.gz: 84643b509932cd1f82cd9ebc9cdbb739c5a7ef8e7460114f84d0929c592b3f376284d14b428b47e0a044e9284b13a656961a68745cc59f6bd93eb538769d3e7f

data/Gemfile

@@ -7,3 +7,4 @@ gemspec
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'
+gem 'yard'

data/README.md

@@ -21,6 +21,50 @@ end
 
 ## Usage
 
+### Loading `has_and_belongs_to_many` Associations
+
+```ruby
+class Student
+  has_and_belongs_to_many :courses
+end
+```
+
+```ruby
+class Course
+  has_and_belongs_to_many :students
+end
+```
+
+```ruby
+class StudentType < GraphQL::Schema::Object
+  field :courses, [CourseType], 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 (...)
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordAssociation, :courses)
+      .load(object)
+  end
+end
+```
+
+```ruby
+class CourseType < GraphQL::Schema::Object
+  field :students, [StudentType], 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 (...)
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordAssociation, :students)
+      .load(object)
+  end
+end
+```
+
 ### Loading `belongs_to` Associations
 
 ```ruby

data/lib/graphql/sources/active_record_association.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # A class for loading an ActiveRecord association.
+    #
+    # @example `has_and_belongs_to_many`
+    #
+    #   class Student
+    #     has_and_belongs_to_many :courses
+    #   end
+    #
+    #   class Course
+    #     has_and_belongs_to_many :students
+    #   end
+    #
+    #   class StudentType < GraphQL::Schema::Object
+    #     field :courses, [CourseType], 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 (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :courses)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    #   class CourseType < GraphQL::Schema::Object
+    #     field :students, [StudentType], 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 (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :students)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    #
+    # @example `has_many` / `belongs_to`
+    #
+    #   class User
+    #     has_many :comments
+    #   end
+    #
+    #   class Comment
+    #     belongs_to :user
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :comments, [CommentType], null: false
+    #
+    #     # @return [Array<Comment>]
+    #     def comments
+    #       # SELECT "comments".* FROM "comments" WHERE "comments"."user_id" = IN (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :comments)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    #   class CommentType < GraphQL::Schema::Object
+    #     field :user, UserType, null: false
+    #
+    #     # @return [User]
+    #     def user
+    #       # SELECT "users".* FROM "users" WHERE "users"."id" IN (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :user)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    # @example `has_one` / `belongs_to`
+    #
+    #   class User
+    #     has_one :profile
+    #   end
+    #
+    #   class Profile
+    #     belongs_to :user
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :profile, ProfileType, null: false
+    #
+    #     # @return [Profile]
+    #     def profile
+    #       # SELECT "profiles".* FROM "profiles" WHERE "profiles"."user_id" = IN (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :profile)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    #   class ProfileType < GraphQL::Schema::Object
+    #     field :user, UserType, null: false
+    #
+    #     # @return [User]
+    #     def user
+    #       # SELECT "users".* FROM "users" WHERE "users"."id" IN (...)
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordAssociation, :user)
+    #         .load(object)
+    #     end
+    #   end
+    class ActiveRecordAssociation < GraphQL::Dataloader::Source
+      # @param association [Symbol] an association to use for loading (e.g. :user)
+      def initialize(association)
+        super()
+        @association = association
+      end
+
+      # @param records [Array<ActiveRecord::Base>] an array of records
+      def fetch(records)
+        preloader = ActiveRecord::Associations::Preloader.new(records: records, associations: [@association])
+        preloader.call
+
+        records.map { |record| record.association(@association).target }
+      end
+    end
+  end
+end

data/lib/graphql/sources/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Sources
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-sources
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -217,6 +217,7 @@ files:
 - LICENSE
 - README.md
 - lib/graphql/sources.rb
+- lib/graphql/sources/active_record_association.rb
 - lib/graphql/sources/active_record_base.rb
 - lib/graphql/sources/active_record_collection.rb
 - lib/graphql/sources/active_record_count.rb
@@ -249,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A set of common GraphQL DataLoader sources.