rspec-graphql_matchers 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef64269a3e7859791ef772fa3fa7e5c1971c23b0
-  data.tar.gz: 383ed8c0d083b7dafc086179c5266ddc37d2b2c4
+  metadata.gz: cb768f28fb26de27d50fa7f3cc904e59538e0f90
+  data.tar.gz: d1e7f770c4db3ee7dedb58635bf37be01fd50a5a
 SHA512:
-  metadata.gz: b3a9c8803fbfe709451399b1a220ffcc2918525e595760b1d2c89f156066dd47dd75ce0a9bfe2520f4e5fb6944733d2e2bcca4082513a1f1bc24196eafffd679
-  data.tar.gz: 6e73cc8a63366f37bd445cc7cbd0d0af44b5a40565d907fc97164e03e298fa01d54dcdb4e0109b47603096a803709a7e290c0843188639d73891f801b7fb38fb
+  metadata.gz: b97f59f215849f232d468f982ce25395c80a24242a16a28f9efc9de451b43228dd375aa098a72e64eb97d65c3c6480576ed2dccce8fdd3ff23c644fd8aec3a3e
+  data.tar.gz: 12082a0895c45baae469d80a86832d5d17fa75750e3a8150d816346b7b52d85921f541a58ee564f12ae3b5f92cbda7b3da7c0db9e9c89b78a64b8ce11f7ae52b

data/CHANGELOG.md

@@ -8,6 +8,12 @@
 
 ### Bug fixes
 
+## 0.6.0 (July 25, 2017)
+
+### New features
+
+  - (PR #6) New matchers for interfaces: `expect(...).to implement(interface)` (Thanks to @marcgreenstock).
+
 ## 0.5.0 (May 10, 2017)
 
 ### New features

data/README.md

@@ -12,6 +12,7 @@ gem 'rspec-graphql_matchers'
 
 The matchers currently supported are:
    - `expect(a_graphql_object).to have_a_field(field_name).that_returns(valid_type)`
+   - `expect(a_graphql_object).to interface(interface_name, ...)`
    - `expect(a_mutation_type).to have_a_return_field(field_name).returning(valid_type)`
    - `expect(a_mutation_type).to have_an_input_field(field_name).of_type(valid_type)`
    - `expect(a_field).to be_of_type(valid_type)`
@@ -33,6 +34,8 @@ PostType = GraphQL::ObjectType.define do
   name "Post"
   description "A blog post"
 
+  interfaces [GraphQL::Relay::Node.interface]
+
   field :id, !types.ID
 
   field :comments, !types[types.String]
@@ -106,11 +109,6 @@ describe PostType do
 end
 ```
 
-Having to define `types` everywhere is quite annoying. If you prefer, you can
-just `include RSpec::GraphqlMatchers::TypesHelper` once 
-(for example in your `spec_helper.rb`)
-and the `types` shortcut will be available within the include context.
-
 ### 3) Test the arguments accepted by a field with `accept_arguments` matcher:
 
 ```ruby
@@ -132,6 +130,20 @@ describe PostType do
 end
 ```
 
+### 4) Test an object's interface implementations:
+
+```ruby
+describe PostType do
+  it 'interfaces Node' do
+    expect(subject).to implement('Node')
+  end
+
+  # Accepts arguments as an array and type objects directly
+  it { is_expected.to implement(GraphQL::Relay::Node.interface) }
+  it { is_expected.not_to implement('OtherInterface') }
+end
+```
+
 The spec will only pass if all attributes/types specified in the hash are
 defined on the field.
 
@@ -156,6 +168,5 @@ contributors are expected to adhere to the
 
 ## License
 
-The gem is available as open source under the terms of the 
+The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/rspec/graphql_matchers/implement.rb

@@ -0,0 +1,46 @@
+require_relative 'base_matcher'
+
+module RSpec
+  module GraphqlMatchers
+    class Implement < BaseMatcher
+      def initialize(interface_names)
+        @expected = interface_names.map(&:to_s)
+      end
+
+      def matches?(graph_object)
+        @graph_object = graph_object
+        @actual = actual
+        @expected.each do |name|
+          return false unless @actual.include?(name)
+        end
+      end
+
+      def failure_message
+        message  = "expected interfaces: #{@expected.join(', ')}\n"
+        message += "actual interfaces:   #{@actual.join(', ')}"
+        message
+      end
+
+      def failure_message_when_negated
+        message  = "unexpected interfaces: #{@expected.join(', ')}\n"
+        message += "actual interfaces:     #{@actual.join(', ')}"
+        message
+      end
+
+      def description
+        "implement #{@expected.join(', ')}"
+      end
+
+      private
+
+      def actual
+        if @graph_object.respond_to?(:interfaces)
+          @graph_object.interfaces.map(&:to_s)
+        else
+          raise "Invalid object #{@graph_object} provided to #{matcher_name} " \
+            'matcher. It does not seem to be a valid GraphQL object type.'
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/matchers.rb

@@ -2,6 +2,7 @@ require 'rspec/matchers'
 require 'rspec/graphql_matchers/be_of_type'
 require 'rspec/graphql_matchers/accept_arguments'
 require 'rspec/graphql_matchers/have_a_field'
+require 'rspec/graphql_matchers/implement'
 
 module RSpec
   module Matchers
@@ -31,5 +32,9 @@ module RSpec
       RSpec::GraphqlMatchers::HaveAField.new(field_name, :return_fields)
     end
     alias have_return_field have_a_return_field
+
+    def implement(*interface_names)
+      RSpec::GraphqlMatchers::Implement.new(interface_names.flatten)
+    end
   end
 end

data/lib/rspec/graphql_matchers/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module GraphqlMatchers
-    VERSION = '0.5'.freeze
+    VERSION = '0.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -112,6 +112,7 @@ files:
 - lib/rspec/graphql_matchers/base_matcher.rb
 - lib/rspec/graphql_matchers/be_of_type.rb
 - lib/rspec/graphql_matchers/have_a_field.rb
+- lib/rspec/graphql_matchers/implement.rb
 - lib/rspec/graphql_matchers/matchers.rb
 - lib/rspec/graphql_matchers/types_helper.rb
 - lib/rspec/graphql_matchers/version.rb
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.