Project

graphql-sources

0.01
The project is in a healthy, maintained state
graphql-sourcesksylvest/graphql-sourcesHomepageDocumentationSource CodeBug TrackerWiki
Common loaders for various database or cache operations.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
9,420
Stars
19
Forks
2
Watchers
1
 Releases
Current version
1.2.0
Total releases
9
First release
2022-07-05
Latest release
2023-10-20
 Pull Requests
Open Pull Requests
4
Closed Pull Requests
43
Merged Pull Requests
90
Pull Request Acceptance Rate
65%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-03-01
Reverse Dependencies
0

 Dependencies

Development

factory_bot
>= 0
pg
>= 0
rspec_junit_formatter
>= 0
rspec-rails
>= 0
rubocop
>= 0
rubocop-rails
>= 0
rubocop-rake
>= 0
rubocop-rspec
>= 0
simplecov
>= 0
rubocop-factory_bot
>= 0

Runtime

graphql
>= 0
rails
>= 0
zeitwerk
>= 0
 Project Readme

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

The GraphQL::Dataloader plugin must be installed in the schema:

class AppSchema < GraphQL::Schema
  use GraphQL::Dataloader
  # ...
end

Usage

Loading belongs_to Associations

class Purchase < ActiveRecord::Base
  belongs_to :visitor
end
class Customer < ActiveRecord::Base
  has_many :purchases
end
class PurchaseType < GraphQL::Schema::Object
  field :customer, [CustomerType], null: false

  def customer
    dataloader
      .with(GraphQL::Sources::ActiveRecordObject, ::Profile, key: :id)
      .load(object.customer_id)
  end
end

Loading has_one Associations

class Profile < ActiveRecord::Base
  belongs_to :user
end
class User < ActiveRecord::Base
  has_one :profile
end
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
SELECT "profiles".*
FROM "profiles"
WHERE "profiles"."user_id" IN (...)
ORDER BY "profiles"."id"

Loading has_many 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
SELECT "comments".*
FROM "comments"
WHERE "comments"."user_id" IN (...)
ORDER BY "comments"."id"

Loading has_one_attached Associations

class User
  has_one_attached :avatar
end
class UserType < GraphQL::Schema::Object
  field :avatar, AttachedType, null: false

  def avatar
    dataloader
      .with(GraphQL::Sources::ActiveStorageHasOneAttached, :avatar)
      .load(object)
  end
end

Loading has_many_attached Associations

class User
  has_many_attached :photos
end
class UserType < GraphQL::Schema::Object
  field :photos, [AttachedType], null: false

  def photos
    dataloader
      .with(GraphQL::Sources::ActiveStorageHasManyAttached, :photos)
      .load(object)
  end
end

Loading Counts

class Like
  belongs_to :post
end
class Post
  has_many :likes
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
SELECT "likes"."post_id", COUNT(*)
FROM "likes"
WHERE "likes"."post_id" IN (1, 2, 3, ...)
GROUP BY "likes"."post_id"

Loading with Rails.cache 

class UserType < GraphQL::Schema::Object
  field :location, String, null: false

  def location
    dataloader
      .with(GraphQL::Sources::RailsCache)
      .load(key: "geocode:#{object.latest_ip}", fallback: -> { Geocode.for(object.latest_ip) })
  end
end

Status

CircleCI Maintainability Test Coverage

License

The gem is available as open source under the terms of the MIT License.