rspec-graphql_matchers 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00d732627e015320d3b20a00b562cc0846b1aa28
-  data.tar.gz: ec338cd6d329e35af1819843cc79eed4c804547a
+  metadata.gz: 305fd4862eb06da7a1f37e7c55b6f9af96eca4e2
+  data.tar.gz: 343daa1c81d534979ee724ed6f5206765fa4109c
 SHA512:
-  metadata.gz: 38a3cb488036ec21f3d688e5d1da919280d57c27b5f05a930072ca492580036b784d1528ae379b082425289b0b834c1ca10d7222c94b838c67245d0b9fbfc1bf
-  data.tar.gz: 65813ccec06ea29b830fe4ed11ca55306a8aba55837c58db5b98f666987365ff6011e7c44a41e14dc837e757d5d1e1bdc0680d8625d3362c39b9fb931d01623a
+  metadata.gz: 0eaaa0082cadbd26d2e9a577c0ed364ad769f5cfffd7fd8cb54784ad9684b2b9e44e0833e9d4fe25a4a6a22ba4a7c9da3298b329fad40a211dca0ce676885da4
+  data.tar.gz: 7ab8f2831ebf8f6dbe80acbd889b6e92ae919b092bf6f796749909ce47cd62542808c5979ab970cc425fbc88374c40045c3d911e102929cce1405b6645628c88

data/CHANGELOG.md

@@ -8,6 +8,20 @@
 
 ### Bug fixes
 
+## 0.4.0 (Feb 10, 2017)
+
+### Breaking changes
+
+### Deprecations
+
+### New features
+
+- Improved error messages for `have_a_field...of_type`
+
+### Bug fixes
+
+- FIXEd Type check when using the form `have_a_field(field_name).of_type(types.X)` not working. It was working if the expected type was provided as a String, but not when using the GraphQL constants.
+
 ## 0.3.0 (Sep 16, 2016)
 
 ### Breaking changes

data/lib/rspec/graphql_matchers/base_matcher.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module GraphqlMatchers
+    class BaseMatcher
+      private
+
+      def types_match?(actual_type, expected_type)
+        expected_type.nil? || expected_type.to_s == actual_type.to_s
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -1,20 +1,27 @@
+require_relative 'base_matcher'
+
 module RSpec
   module GraphqlMatchers
-    class HaveAField
-      def initialize(field_name)
-        @field_name = field_name.to_s
-        @field_type = @graph_object = nil
+    class HaveAField < BaseMatcher
+      def initialize(expected_field_name)
+        @expected_field_name = expected_field_name.to_s
+        @expected_field_type = @graph_object = nil
       end
 
       def matches?(graph_object)
         @graph_object = graph_object
 
-        actual_field = @graph_object.fields[@field_name]
-        actual_field && types_match?(@field_type, actual_field.type)
+        unless @graph_object.respond_to?(:fields)
+          raise "Invalid object #{@graph_object} provided to have_a_field " \
+            'matcher. It does not seem to be a valid GraphQL object type.'
+        end
+
+        @actual_field = @graph_object.fields[@expected_field_name]
+        valid_field? && types_match?(@actual_field.type, @expected_field_type)
       end
 
-      def that_returns(field_type)
-        @field_type = field_type
+      def that_returns(expected_field_type)
+        @expected_field_type = expected_field_type
 
         self
       end
@@ -22,23 +29,38 @@ module RSpec
       alias of_type that_returns
 
       def failure_message
-        "expected #{describe_obj(@graph_object)} to #{description}"
+        "expected #{describe_obj(@graph_object)} to " \
+          "#{description}, #{explanation}."
       end
 
       def description
-        "define field `#{@field_name}`" + of_type_description
+        "define field `#{@expected_field_name}`" + of_type_description
       end
 
       private
 
-      def of_type_description
-        return '' unless @field_type
+      def explanation
+        return 'but no field was found with that name' unless @actual_field
+
+        "but the field type was `#{@actual_field.type}`"
+      end
+
+      def valid_field?
+        unless @expected_field_type.nil? || @actual_field.respond_to?(:type)
+          error_msg = "The `#{@expected_field_name}` field defined by the GraphQL " \
+          'object does\'t seem valid as it does not respond to #type. ' \
+          "\n\n\tThe field found was #{@actual_field.inspect}. "
+          puts error_msg
+          raise error_msg
+        end
 
-        " of type `#{@field_type}`"
+        @actual_field
       end
 
-      def types_match?(expected_type, actual_type)
-        !expected_type || expected_type.to_s == actual_type.to_s
+      def of_type_description
+        return '' unless @expected_field_type
+
+        " of type `#{@expected_field_type}`"
       end
 
       def describe_obj(field)

data/lib/rspec/graphql_matchers/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module GraphqlMatchers
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -109,6 +109,7 @@ files:
 - bin/setup
 - lib/rspec/graphql_matchers.rb
 - lib/rspec/graphql_matchers/accept_arguments.rb
+- 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/matchers.rb