RSpecExtraMatchers

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/rspec/extra_matchers. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'rspec_extra_matchers'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rspec_extra_matchers

Usage

To make RSpec extra matchers accessible, add this to your spec_helper.rb:

require 'rspec_extra_matchers'

RSpec.configure do |config|
  config.include RSpecExtraMatchers
end

Matchers

satisfy_graphql_type matcher

satisfy_graphql_type checks if a given instance is suitable for a given graphql type:

describe User do
  it 'valid type for user' do
    user = User.new(name: 'John Doe')

    expect(user).to satisfy_graphql_type(Graphql::UserType)
  end
end

be_valid_graphql_type_for matcher

The opposite of satisfy_graphql_type. Checks if given GraphQL type or decorator is suitable for given instance:

describe Graphql::UserType do
  it 'valid type for user' do
    user = User.new(name: 'John Doe')

    expect(described_class).to be_valid_graphql_type_for(user)
  end
end

be_valid_graphql_decorator matcher

Shortcut for:

expect(record.class).to be_valid_graphql_type_for(record)

Useful when working with GraphqlRails style types:

class Graphql::UserDecorator
  include GraphqlRails::Decorator

  graphql do |c|
    c.attribute(:id).type('ID!')
  end

  delegate :id, to: :@user

  def initialize(user)
    @user = user
  end
end

describe Graphql::UserDecorator do
  it 'valid type for user' do
    user = User.new(name: 'John Doe')
    user_decorator = described_class.new(user)

    expect(user_decorator).to be_valid_graphql_decorator
  end
end

deeply also checks the fields of nested types; shallow mode checks only their class, except for list items, whose fields are always checked. Each nested object is checked once: one with an id is known by its GraphQL type and id, so a cycle of decorators rebuilt on every call ends when it reaches a record already checked.

Query context

A GraphqlRails model that reads graphql_context gets it from the query at runtime. Give the matchers one with with_graphql_context, which works on satisfy_graphql_type, be_valid_graphql_type_for and be_valid_graphql_decorator:

expect(shift_decorator).to be_valid_graphql_decorator.with_graphql_context(current_user: user)

Fields with arguments

The matchers call every field method with only the default values of its arguments. A field with a required argument needs them given with with_arguments, keyed by field path. Paths take Ruby or GraphQL names, and list indexes are left out. Argument names are the Ruby keywords the method takes (post_id, not postId):

class Graphql::UserDecorator
  include GraphqlRails::Model

  graphql do |c|
    c.attribute(:post).type('Post!').permit(id: 'ID!')
  end

  def initialize(user)
    @user = user
  end

  def post(id:)
    @user.posts.find(id)
  end
end

it 'valid type for user' do
  expect(user_decorator).to be_valid_graphql_decorator.deeply.with_arguments(post: { id: post.id })
end

with_arguments also works on satisfy_graphql_type, be_valid_graphql_type_for and be_successful_graphql_request. Default values are passed as they are declared, without the input coercion and prepare: GraphQL applies, so they fit scalar arguments best. Arguments that field extensions consume, such as the first, last, before and after of connections, are not supported.

be_successful_graphql_request matcher

Works with GraphqlRails only. Checks if controller response matches what is defined in action configuration

class Graphql::UsersController
  action(:index).returns('[User]')
  def index
    User.all
  end
end

describe Graphql::UsersController, type: :graphql_controller do
  describe '#index' do
    subject(:response) { query(:index) }

    it 'returns successful response' do
      expect(response).to be_successful_graphql_request
    end
  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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/povilasjurcys/rspec_extra_matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the RSpecExtraMatchers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.