dry-graphql
makes dry-types and
dry-struct play nicely with GraphQL. It
adds a graphql_type
method which will automatically generate a
graphql-ruby. This takes the manual work out of
maintaining multiple type definitions. Specify your dry-type
, and re-use it
for GraphQL.
Here is an example of using it with dry-struct
:
class User < Dry::Struct
module Types
include Dry.Types()
end
attribute :name, Types::Strict::String.optional
attribute :age, Types::Coercible::Integer
attribute :middle_name, Types::Coercible::String
end
class UserType < User.graphql_type(only: [:name, :age])
# you can add other fields here if you want
end
class Query < GraphQL::Schema::Object
field :user, UserType, null: false
end
class Schema < GraphQL::Schema
query Query
end
puts schema.to_definition # =>
# type Query {
# user: User!
# }
#
# type User {
# age: Int!
# name: String
# }
end
To add a graphql_type
method to a ROM::Relation
:
require 'dry/graphql/rom'
class Users < ROM::Relation[:sql]
extend Dry::GraphQL::ROM
end
Add this line to your application's Gemfile:
gem 'dry-graphql'
And then execute:
$ bundle
Or install it yourself as:
$ gem install dry-graphql
After checking out the repo, run bin/setup
to install dependencies. Then, run
rake spec
to run the tests. You can also run bin/console
for an interactive
prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To
release a new version, update the version number in version.rb
, and then run
bundle exec rake release
, which will create a git tag for the version, push
git commits and tags, and push the .gem
file to
rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/adhawk/dry-graphql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Dry::GraphQL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.