rspec-graphql_response 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647c52ffa5ae347bc9c2166bd94af15ee82556d10f37fa5a11a0cf0229d40b31
-  data.tar.gz: a93873e4d4a40a9a4702026321d96d913056188dd51eec86836232add5e7c4b7
+  metadata.gz: 7104f657d559b5617486876024bc92367f177b94734ac8f224452cf6e4917f3e
+  data.tar.gz: f9c0df4206c1dd6c02f7b744b5edaa91c877a2e0be5c1ee235d6a05e0c3df9f0
 SHA512:
-  metadata.gz: 9ad72db1bdd814a65f02cf4ee9a59c9836c452003fe840e9c28903aa805ab0553fcd7afa4558d610c63c5ae1959fea61690f037641bd3fa31b417c378ed1805a
-  data.tar.gz: 46ec7e724d5784feb01e33fbb5024d9c8713ddb8df77a1efb2273f1dd94c2bf8c3658ecb1f11ad9065741119b6e4a71815f9911ba3e87a779caafe97563b2dd8
+  metadata.gz: 71ef7903cb4b46d5588b03402a5c3e44d6c61e13b898f8269f44ec3acd3b976cd3c77f921b68fc050dab0a20700f5846007c79cacfef8acfe1516f6af1a2045d
+  data.tar.gz: e9bbad747532e9fca29ed6e0bf8b4299be8896344f9541527bff4f71242ecfe4117f02d9946d0aece0215ec1952ce391bb5bfe74eccce747c167da52fe06acb2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-graphql_response (0.4.1)
+    rspec-graphql_response (0.5.0)
       graphql (>= 1.0)
       rspec (>= 3.0)
 

data/README.md

@@ -43,7 +43,7 @@ Configuration:
 Custom Matchers:
 
 - [have_errors](/docs/have_errors.md) - validates errors, or lack of, on the GraphQL response
-- [have_operation](/docs/have_operation.md) - validates the presence of a specified graphql operation in the graphql response
+- [have_field](/docs/have_field.md) - validates the presence of a specified graphql operation in the graphql response
 
 Context / Describe Helper Methods:
 
@@ -162,11 +162,11 @@ RSpec.describe Some::Thing, type: :graphql do
 end
 ```
 
-#### Retrieve operation results with `operation`
+#### Retrieve response results with `response_data`
 
 Now that the GraphQL query has been executed and a response has been obtained, it's time to check for the results of a GraphQL
 operation. In the previous example, the spec is expecting to find `data` with `characters` in the response hash. To reduce the
-nested hash checking, use the built-in `operation` method to retrieve the `characters`:
+nested hash checking, use the built-in `response_data` method to retrieve the `characters`:
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
@@ -180,18 +180,17 @@ RSpec.describe Some::Thing, type: :graphql do
   GQL
 
   it "executes the query" do
-    characters = operation(:characters)
-
-    expect(characters).to include(
+    expect(response_data :characters).to include(
       # ...
     )
   end
 end
 ```
 
-Note the lack of `response` use here. Internally, the `operation` method uses the `response` to obtain the data requested. This
+Note the lack of `response` use here. Internally, the `response_data` method uses the `response` to obtain the data requested. This
 means the entire chain of operations from executing the GraphQL request, to converting the response into a hash, and digging
-through the results to find the correction operation, has been handled behind the scenes.
+through the results to find the correction operation, has been handled behind the scenes. To see more examples of how to use
+`response_data` dig through your response check out it's full documenation [here.](/docs/response_data.md)
 
 ## Development
 

data/RELEASE_NOTES.md

@@ -4,6 +4,11 @@ Release notes for various versions of RSpec::GraphQLResponse
 
 See [the upgrade guide](/UPGRADE.md) for details on changes between versions and how to upgrade.
 
+## v0.5.0 - Helper API change
+
+- Fully deprecates `operation`.
+- Renames `have_operation` to `have_field` to clarify its use.
+
 ## v0.4.0 - Helper API change
 
 ### Breaking Changes

data/docs/{have_operation.md → have_field.md}

@@ -1,4 +1,4 @@
-# Validate a response operation with `have_operation(name)`
+# Validate a response operation with `have_field(name)`
 
 Check for the presence of an operation's results. Useful when you want to ensure an operation exists before
 retrieving the operation's results.
@@ -18,7 +18,7 @@ RSpec.describe My::Characters, type: :graphql do
 
   it "has the characters" do
 
-    expect(response).to have_operation(:characters)
+    expect(response).to have_field(:characters)
 
   end
 end
@@ -39,7 +39,7 @@ RSpec.describe My::Characters, type: :graphql do
 
   it "does not have books" do
 
-    expect(response).to_not have_operation(:books)
+    expect(response).to_not have_field(:books)
 
   end
 end

data/lib/rspec/graphql_response/helpers.rb

@@ -46,6 +46,5 @@ require_relative "helpers/graphql_variables"
 
 # spec level helpers
 require_relative "helpers/execute_graphql"
-require_relative "helpers/operation"
 require_relative "helpers/response"
 require_relative "helpers/response_data"

data/lib/rspec/graphql_response/matchers.rb

@@ -12,4 +12,4 @@ module RSpec
 end
 
 require_relative "matchers/have_errors"
-require_relative "matchers/have_operation"
+require_relative "matchers/have_field"

data/lib/rspec/graphql_response/matchers/{have_operation.rb → have_field.rb}

@@ -1,6 +1,6 @@
-RSpec::GraphQLResponse.add_matcher :have_operation do |operation_name|
+RSpec::GraphQLResponse.add_matcher :have_field do |operation_name|
   match do |response|
-    validator = RSpec::GraphQLResponse.validator(:have_operation)
+    validator = RSpec::GraphQLResponse.validator(:have_field)
 
     @result = validator.validate(response, operation_name: operation_name)
     @result.valid?
@@ -11,7 +11,7 @@ RSpec::GraphQLResponse.add_matcher :have_operation do |operation_name|
   end
 
   match_when_negated do |response|
-    validator = RSpec::GraphQLResponse.validator(:have_operation)
+    validator = RSpec::GraphQLResponse.validator(:have_field)
 
     @result = validator.validate_negated(response, operation_name: operation_name)
     @result.valid?

data/lib/rspec/graphql_response/validators.rb

@@ -23,4 +23,4 @@ module RSpec
 end
 
 require_relative "validators/have_errors"
-require_relative "validators/have_operation"
+require_relative "validators/have_field"

data/lib/rspec/graphql_response/validators/{have_operation.rb → have_field.rb}

@@ -1,4 +1,4 @@
-RSpec::GraphQLResponse.add_validator :have_operation do
+RSpec::GraphQLResponse.add_validator :have_field do
   failure_message :nil, "Cannot evaluate operations on nil"
   failure_message :not_found, ->(expected, actual) { "Expected to find operation result named #{expected}, but did not find it\n\t#{actual}" }
 

data/lib/rspec/graphql_response/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module GraphQLResponse
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_response
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - River Lynn Bailey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,7 +140,7 @@ files:
 - docs/execute_graphql.md
 - docs/graphql_spec_type.md
 - docs/have_errors.md
-- docs/have_operation.md
+- docs/have_field.md
 - docs/operation.md
 - docs/response.md
 - docs/response_data.md
@@ -152,15 +152,14 @@ files:
 - lib/rspec/graphql_response/helpers/graphql_context.rb
 - lib/rspec/graphql_response/helpers/graphql_operation.rb
 - lib/rspec/graphql_response/helpers/graphql_variables.rb
-- lib/rspec/graphql_response/helpers/operation.rb
 - lib/rspec/graphql_response/helpers/response.rb
 - lib/rspec/graphql_response/helpers/response_data.rb
 - lib/rspec/graphql_response/matchers.rb
 - lib/rspec/graphql_response/matchers/have_errors.rb
-- lib/rspec/graphql_response/matchers/have_operation.rb
+- lib/rspec/graphql_response/matchers/have_field.rb
 - lib/rspec/graphql_response/validators.rb
 - lib/rspec/graphql_response/validators/have_errors.rb
-- lib/rspec/graphql_response/validators/have_operation.rb
+- lib/rspec/graphql_response/validators/have_field.rb
 - lib/rspec/graphql_response/validators/validation_base.rb
 - lib/rspec/graphql_response/validators/validation_result.rb
 - lib/rspec/graphql_response/validators/validation_runner.rb

data/lib/rspec/graphql_response/helpers/operation.rb

@@ -1,6 +0,0 @@
-RSpec::GraphQLResponse.add_helper :operation do |name|
-  warn 'WARNING: operation has been deprecated in favor of response_data. This helper will be removed in v0.5'
-  return nil unless response.is_a? Hash
-
-  response.dig("data", name.to_s)
-end