rspec-graphql_matchers 1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 277f87e873956d23acf342b90a249ca925ebba90d3ef98f14a5c7e9a7564df01
-  data.tar.gz: 8b70cc404872f1ac41d53aa3de266f1d25e9d217bcb5dcd37384cd57249eb346
+  metadata.gz: 3e5dc9d71a93c8f0a762604ae835b0334ce1a7ecda6283a940a6b1a834afb81c
+  data.tar.gz: 2f119e9bc7d6b33c7ab1c307504a1f842dae6b6255007d6148a869569493b5f3
 SHA512:
-  metadata.gz: a30d237270557a0b67c36bbe406c2413997cce4c673e2ba416d8b0ad48dc1b961fca3689e29eaa90c106e4a945f82bc16abfbcc4fc0de7ca145a91214611de67
-  data.tar.gz: 37ddb46780ee142f17008757f1c86e5cfad473adbc84d888e7ed4d64965e84f20cc098af8c137aa28d2da3416fcf3dbc3b3d434d9c524006ec618577eb0cbfc2
+  metadata.gz: eecf40946e48ee1d4bb0cb8ae1266902c3897e8d563a772501540945ca897d4a8c9908485c6979ba3a76ffe7ece12c216ed2383c20171372f3bed4c98df66d19
+  data.tar.gz: f50e95f77105b2d64645a13f75b1735439176eece7991286785450a1faafa73f47c96277776ad59a5aa4c5acd16ffc85af64006c6a7e89a2029bb0dfbad74534

data/CHANGELOG.md

@@ -8,6 +8,10 @@
 
 ### Bug fixes
 
+## 1.2.1 (March 31st, 2020)
+
+-   Fixed issue causing the last release to break expectations against snake_cased fields (fixes https://github.com/khamusa/rspec-graphql_matchers/issues/30).
+
 ## 1.2 (Feb 6th, 2020)
 
 -   Added support to underscored arguments in have_field (https://github.com/khamusa/rspec-graphql_matchers/pull/29 thanks to @makketagg)

data/README.md

@@ -63,6 +63,10 @@ describe PostType do
   it { is_expected.to have_field(:id).of_type(!types.ID) }
   it { is_expected.to have_field(:comments).of_type("[String!]!") }
   it { is_expected.to have_field(:isPublished).of_type("Boolean") }
+
+  # 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") }
 end
 ```
 
@@ -138,10 +142,45 @@ describe PostType do
 end
 ```
 
+### 6) Using camelize: false on field names
+
+By default the graphql gem camelizes field names. This gem deals with it transparently:
+
+```ruby
+class ObjectMessingWithCamelsAndSnakesType < GraphQL::Schema::Object
+  graphql_name 'ObjectMessingWithCamelsAndSnakes'
+
+  implements GraphQL::Relay::Node.interface
+
+  field :me_gusta_los_camellos, ID, null: false
+
+  # note the camelize: false
+  field :prefiero_serpientes, ID, null: false, camelize: false
+end
+```
+
+The following specs demonstrate the current behavior of the gem regarding fields:
+
+```ruby
+describe ObjectMessingWithCamelsAndSnakesType do
+  subject { described_class }
+
+  # For a field name that was automatically camelized, you can add expectations
+  # against both versions and we handle it transparently:
+  it { is_expected.to have_a_field(:meGustaLosCamellos) }
+  it { is_expected.to have_a_field(:me_gusta_los_camellos) }
+
+  # However, when using camelize: false, you have to use the exact case of the field definition:
+  it { is_expected.to have_a_field(:prefiero_serpientes) }
+  it { is_expected.not_to have_a_field(:prefieroSerpientes) } # Note we're using `not_to`
+end
+```
+
+This behaviour is currently active only on field name matching. PRs are welcome to
+reproduce it to arguments as well.
+
 ## TODO
 
--   Support GraphQL 1.9.x;
--   Check the method used for resolving a field;
 -   New matchers!
 
 ## Contributing

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -10,7 +10,10 @@ module RSpec
   module GraphqlMatchers
     class HaveAField < BaseMatcher
       def initialize(expected_field_name, fields = :fields)
-        @expected_field_name = GraphQL::Schema::Member::BuildType.camelize(expected_field_name.to_s)
+        @expected_field_name = expected_field_name.to_s
+        @expected_camel_field_name = GraphQL::Schema::Member::BuildType.camelize(
+          @expected_field_name
+        )
         @fields = fields.to_sym
         @expectations = []
       end
@@ -18,12 +21,10 @@ module RSpec
       def matches?(graph_object)
         @graph_object = graph_object
 
-        @actual_field = field_collection[@expected_field_name]
-        @actual_field = @actual_field.to_graphql if @actual_field.respond_to?(:to_graphql)
-        return false if @actual_field.nil?
+        return false if actual_field.nil?
 
         @results = @expectations.reject do |matcher|
-          matcher.matches?(@actual_field)
+          matcher.matches?(actual_field)
         end
 
         @results.empty?
@@ -57,7 +58,7 @@ module RSpec
         base_msg = "expected #{member_name(@graph_object)} " \
           "to define field `#{@expected_field_name}`" \
 
-        return "#{base_msg} #{failure_messages.join(', ')}" if @actual_field
+        return "#{base_msg} #{failure_messages.join(', ')}" if actual_field
 
         "#{base_msg} but no field was found with that name"
       end
@@ -68,6 +69,15 @@ module RSpec
 
       private
 
+      def actual_field
+        @actual_field ||= begin
+          field = field_collection[@expected_field_name]
+          field ||= field_collection[@expected_camel_field_name]
+
+          field.respond_to?(:to_graphql) ? field.to_graphql : field
+        end
+      end
+
       def descriptions
         @results.map(&:description)
       end

data/lib/rspec/graphql_matchers/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.1
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql