graphql-sources 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5e22be9513129488382bdbbf924e8556528176f0b1f4a8313ab4c1637c8c752
+  data.tar.gz: ac16703211688fb933cf42bcb0d0b3cfea158027aee5341c2332daf6849ef0ed
+SHA512:
+  metadata.gz: 11eed0b5dc6e7176c92a985ebc5b7a3eb63907aa9a1604541322539f3a1f9f0e0605c87d63ee8d1997eba838ebeb2558158e2a90dfc61c9fd1deb8bb36d25e0d
+  data.tar.gz: 2e8bf4989abec1c9cf34a21be060917052e97f03635e4116a4efa9e1a82164d4df9eb5a27583fc81e4ffd651d77f9a0d2fdf79fd6b5a66d3841a25851140f420

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'debug'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kevin Sylvestre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# GraphQL::Sources
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add graphql-sources
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install graphql-sources
+
+## Usage
+
+### 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
+
+  def profile
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordObject, ::Profile, key: :user_id)
+      .load(object.id)
+  end
+end
+```
+
+```sql
+SELECT "profiles".*
+FROM "profiles"
+WHERE "profiles"."user_id" IN (...)
+ORDER BY "profiles"."id"
+```
+
+### Loading `has_many` Associations
+
+```ruby
+class User
+  has_many :comments
+end
+```
+
+```ruby
+class Comment
+  belongs_to :user
+end
+```
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  field :comments, [CommentType], null: false
+
+  def profile
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordCollection, ::Comment, key: :user_id)
+      .load(object.id)
+  end
+end
+```
+
+```sql
+SELECT "comments".*
+FROM "comments"
+WHERE "comments"."user_id" IN (...)
+ORDER BY "comments"."id"
+```
+
+### Loading Counts
+
+```ruby
+class Like
+  belongs_to :post
+end
+```
+
+```ruby
+class Post
+  has_many :likes
+end
+```
+
+```ruby
+class PostType < GraphQL::Schema::Object
+  field :likes, Integer, null: false
+
+  def comments
+    dataloader
+      .with(GraphQL::Sources::ActiveRecordCount, ::Like, key: :post_id)
+      .load(object.id)
+  end
+end
+```
+
+```sql
+SELECT "likes"."post_id", COUNT(*)
+FROM "likes"
+WHERE "likes"."post_id" IN (1, 2, 3, ...)
+GROUP BY "likes"."post_id"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/graphql/sources/active_record_base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # An abstract class for interacting with active record.
+    class ActiveRecordBase < GraphQL::Dataloader::Source
+      # @param model [Class] a child class of ActiveRecord::Base (e.g. Comment)
+      # @param key [Symbol] an attribute (typically a foreign key) to use for loading (e.g. :user_id)
+      def initialize(model, key:)
+        super()
+        @model = model
+        @key = key
+      end
+
+      protected
+
+      # @param keys [Array] an array of keys
+      # @return [ActiveRecord_Relation] a collection of records
+      def models(keys:)
+        @model.where(@key => keys)
+      end
+    end
+  end
+end

data/lib/graphql/sources/active_record_collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative './active_record_base'
+
+module GraphQL
+  module Sources
+    # A class for loading `has_many` style associations.
+    #
+    #   class User
+    #     has_many :comments
+    #   end
+    #
+    #   class Comment
+    #     belongs_to :user
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :comments, [CommentType], null: false
+    #
+    #     def comments
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordCollection, ::Comment, key: :user_id)
+    #         .load(object.id)
+    #     end
+    #   end
+    #
+    # The resulting SQL query is:
+    #
+    #     SELECT "comments".*
+    #     FROM "comments"
+    #     WHERE "comments"."user_id" IN (...)
+    #     ORDER BY "comments"."id"
+    class ActiveRecordCollection < ActiveRecordBase
+      def fetch(keys)
+        models = models(keys: keys).order(:id).load_async
+        dataloader.yield
+
+        map = models.group_by { |model| model[@key] }
+        keys.map { |key| map[key] || [] }
+      end
+    end
+  end
+end

data/lib/graphql/sources/active_record_count.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative './active_record_base'
+
+module GraphQL
+  module Sources
+    # A class for loading a count of records.
+    #
+    #   class Post
+    #     has_many :likes
+    #   end
+    #
+    #   class Like
+    #     belongs_to :post
+    #   end
+    #
+    #   class PostType < GraphQL::Schema::Object
+    #     field :likes, Integer, null: false
+    #
+    #     def likes
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordCount, ::Like, key: :post_id)
+    #         .load(object.id)
+    #     end
+    #   end
+    #
+    # The resulting SQL query is:
+    #
+    #     SELECT "likes"."post_id", COUNT(*)
+    #     FROM "likes"
+    #     WHERE "likes"."post_id" IN (1, 2, 3, ...)
+    #     GROUP BY "likes"."post_id"
+    class ActiveRecordCount < ActiveRecordBase
+      def fetch(keys)
+        map = models(keys: keys).group(@key).count
+        keys.map { |key| map[key] || 0 }
+      end
+    end
+  end
+end

data/lib/graphql/sources/active_record_object.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative './active_record_base'
+
+module GraphQL
+  module Sources
+    # A class for loading `has_one` style associations.
+    #
+    #   class User
+    #     has_one :profile
+    #   end
+    #
+    #   class Profile
+    #     belongs_to :user
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :profile, [ProfileType], null: false
+    #
+    #     def profile
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveRecordCollection, ::Profile, key: :user_id)
+    #         .load(object.id)
+    #     end
+    #   end
+    #
+    # The resulting SQL query is:
+    #
+    #     SELECT "profiles".*
+    #     FROM "profiles"
+    #     WHERE "profiles"."user_id" IN (1, 2, 3, ...)
+    #     ORDER BY "profiles"."id"
+    class ActiveRecordObject < ActiveRecordBase
+      def fetch(keys)
+        models = models(keys: keys).order(:id).load_async
+        dataloader.yield
+
+        map = models.index_by { |model| model[@key] }
+        keys.map { |key| map[key] }
+      end
+    end
+  end
+end

data/lib/graphql/sources/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    VERSION = '0.1.0'
+  end
+end

data/lib/graphql/sources.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+require_relative './sources/active_record_count'
+require_relative './sources/active_record_collection'
+require_relative './sources/active_record_object'
+
+module GraphQL
+  # A collection of common GraphQL dataloader classes.
+  module Sources
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: graphql-sources
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Common loaders for various database or cache operations.
+email:
+- kevin@ksylvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/graphql/sources.rb
+- lib/graphql/sources/active_record_base.rb
+- lib/graphql/sources/active_record_collection.rb
+- lib/graphql/sources/active_record_count.rb
+- lib/graphql/sources/active_record_object.rb
+- lib/graphql/sources/version.rb
+homepage: https://github.com/ksylvest/graphql-sources
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ksylvest/graphql-sources
+  source_code_uri: https://github.com/ksylvest/graphql-sources
+  changelog_uri: https://github.com/ksylvest/graphql-sources/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A set of common GraphQL DataLoader sources.
+test_files: []