Build Status

BetterGraphQL::DetectInvalidIdField

Detect invalid id field for GraphQL types by detecting divergent fields between nodes representing the same object.

Installation

Add this line to your application's Gemfile:

gem 'better-graphql-detect-invalid-id-field'

And then execute:

$ bundle

Or install it yourself as:

$ gem install better-graphql-detect-invalid-id-field

Usage

Add to your schema:

class YourSchema < GraphQL::Schema
  query(QueryType)

  if Rails.env.test? || Rails.env.development?
    require 'better_graphql/detect_invalid_id_field'
    use ::BetterGraphQL::DetectInvalidIdField
  end
end

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/gtkatakura/better-graphql-detect-invalid-id-field.

License

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