rspec-graphql_matchers 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5dc9d71a93c8f0a762604ae835b0334ce1a7ecda6283a940a6b1a834afb81c
-  data.tar.gz: 2f119e9bc7d6b33c7ab1c307504a1f842dae6b6255007d6148a869569493b5f3
+  metadata.gz: 9b3cd22e67266948bf838945b0330bf050d19c44a4e336cfcd2fec2ad629350f
+  data.tar.gz: 14637372879e218e39922e323614d47426a93370425ed083b94dbec8ed597340
 SHA512:
-  metadata.gz: eecf40946e48ee1d4bb0cb8ae1266902c3897e8d563a772501540945ca897d4a8c9908485c6979ba3a76ffe7ece12c216ed2383c20171372f3bed4c98df66d19
-  data.tar.gz: f50e95f77105b2d64645a13f75b1735439176eece7991286785450a1faafa73f47c96277776ad59a5aa4c5acd16ffc85af64006c6a7e89a2029bb0dfbad74534
+  metadata.gz: 0bc45acd938927b143eb669e042f5ebcd6758be29602761d31b3101e77d722a66cbc896459f326fa9a44779bd1f6139c0e23b9a0f3d6e31418d6feb90526e58c
+  data.tar.gz: e011517e436af44e654b31847d561c2f588a5a12315d06235dbd2ad0d12770a7281e242d73c13772565c0885dc05ecd0fc7bdb19824365a3c7583c6c5dd74522

data/CHANGELOG.md

@@ -1,12 +1,9 @@
 # Changelog
 
-### Breaking changes
-
-### Deprecations
+## 1.3.0 (May 7th, 2020)
 
-### New features
-
-### Bug fixes
+-   `accept_argument` matcher accepts underscored argument names and passes even if the actual argument is camel-cased (https://github.com/khamusa/rspec-graphql_matchers/pull/32 thanks to @TonyArra);
+-   `have_a_field` matcher accepts `.with_deprecation_reason` (https://github.com/khamusa/rspec-graphql_matchers/pull/34 thanks to @TonyArra).
 
 ## 1.2.1 (March 31st, 2020)
 

data/README.md

@@ -46,10 +46,12 @@ class PostType < GraphQL::Schema::Object
   field :id, ID, null: false
   field :comments, [String], null: false
   field :isPublished, Boolean, null: true
+  field :published, Boolean, null: false, deprecation_reason: 'Use isPublished instead'
 
   field :subposts, PostType, null: true do
     argument :filter, types.String, required: false
     argument :id, types.ID, required: false
+    argument :isPublished, types.Boolean, required: false
   end
 end
 ```
@@ -64,6 +66,12 @@ describe PostType do
   it { is_expected.to have_field(:comments).of_type("[String!]!") }
   it { is_expected.to have_field(:isPublished).of_type("Boolean") }
 
+  # Check a field is deprecated
+  it { is_expected.to have_field(:published).with_deprecation_reason }
+  it { is_expected.to have_field(:published).with_deprecation_reason('Use isPublished instead') }
+  it { is_expected.not_to have_field(:published).with_deprecation_reason('Wrong reason') }
+  it { is_expected.not_to have_field(:isPublished).with_deprecation_reason }
+
   # The gem automatically converts field names to CamelCase, so this will
   # pass even though the field was defined as field :isPublished
   it { is_expected.to have_field(:is_published).of_type("Boolean") }
@@ -122,6 +130,10 @@ describe PostType do
     end
 
     it { is_expected.not_to accept_argument(:weirdo) }
+
+    # The gem automatically converts argument names to CamelCase, so this will
+    # pass even though the argument was defined as :isPublished
+    it { is_expected.to accept_argument(:is_published).of_type("Boolean") }
   end
 end
 ```

data/lib/rspec/graphql_matchers/accept_argument.rb

@@ -17,12 +17,16 @@ module RSpec
         end
 
         @expected_arg_name = expected_arg_name.to_s
+        @expected_camel_arg_name = GraphQL::Schema::Member::BuildType.camelize(
+          @expected_arg_name
+        )
       end
 
       def matches?(graph_object)
         @graph_object = graph_object
 
         @actual_argument = field_arguments[@expected_arg_name]
+        @actual_argument ||= field_arguments[@expected_camel_arg_name]
         return false if @actual_argument.nil?
 
         @results = @expectations.select do |matcher|

data/lib/rspec/graphql_matchers/accept_arguments.rb

@@ -29,7 +29,9 @@ module RSpec
       private
 
       def matches_argument?(arg_name, arg_type)
+        camel_arg_name = GraphQL::Schema::Member::BuildType.camelize(arg_name.to_s)
         actual_arg = actual_field.arguments[arg_name.to_s]
+        actual_arg ||= actual_field.arguments[camel_arg_name]
 
         actual_arg && types_match?(actual_arg.type, arg_type)
       end

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -5,6 +5,7 @@ require_relative './have_a_field_matchers/of_type'
 require_relative './have_a_field_matchers/with_property'
 require_relative './have_a_field_matchers/with_metadata'
 require_relative './have_a_field_matchers/with_hash_key'
+require_relative './have_a_field_matchers/with_deprecation_reason'
 
 module RSpec
   module GraphqlMatchers
@@ -54,6 +55,11 @@ module RSpec
         self
       end
 
+      def with_deprecation_reason(expected_reason = nil)
+        @expectations << HaveAFieldMatchers::WithDeprecationReason.new(expected_reason)
+        self
+      end
+
       def failure_message
         base_msg = "expected #{member_name(@graph_object)} " \
           "to define field `#{@expected_field_name}`" \

data/lib/rspec/graphql_matchers/have_a_field_matchers/with_deprecation_reason.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class WithDeprecationReason
+        def initialize(expected_reason)
+          @expected_reason = expected_reason
+        end
+
+        def matches?(actual_field)
+          @actual_reason = actual_field.deprecation_reason
+
+          if @expected_reason.nil?
+            !actual_field.deprecation_reason.nil?
+          else
+            actual_field.deprecation_reason == @expected_reason
+          end
+        end
+
+        def failure_message
+          message = "#{description}, but it was "
+          message + (@actual_reason.nil? ? 'not deprecated' : "`#{@actual_reason}`")
+        end
+
+        def description
+          if @expected_reason.nil?
+            'with a deprecation reason'
+          else
+            "with deprecation reason `#{@expected_reason}`"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Rspec
   module GraphqlMatchers
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -114,6 +114,7 @@ files:
 - lib/rspec/graphql_matchers/be_of_type.rb
 - lib/rspec/graphql_matchers/have_a_field.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/of_type.rb
+- lib/rspec/graphql_matchers/have_a_field_matchers/with_deprecation_reason.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_hash_key.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_metadata.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_property.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.