Merge pull request #9 from testdouble/migrate--have_operation-helper

`have_operation` ->  `have_field`

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)
 

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
 

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

docs/have_operation.md → docs/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

lib/rspec/graphql_response/helpers.rb

@@ -46,6 +46,5 @@ def self.add_helper(name, scope: :spec, &helper)
 
 # spec level helpers
 require_relative "helpers/execute_graphql"
-require_relative "helpers/operation"
 require_relative "helpers/response"
 require_relative "helpers/response_data"

lib/rspec/graphql_response/matchers.rb

@@ -12,4 +12,4 @@ def self.add_matcher(name, &matcher)
 end
 
 require_relative "matchers/have_errors"
-require_relative "matchers/have_operation"
+require_relative "matchers/have_field"

lib/rspec/graphql_response/matchers/have_operation.rb → lib/rspec/graphql_response/matchers/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 @@
   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?

lib/rspec/graphql_response/validators.rb

@@ -23,4 +23,4 @@ def self.validator(name)
 end
 
 require_relative "validators/have_errors"
-require_relative "validators/have_operation"
+require_relative "validators/have_field"

lib/rspec/graphql_response/validators/have_operation.rb → lib/rspec/graphql_response/validators/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}" }
 

lib/rspec/graphql_response/version.rb

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

spec/graphql_response/matchers/have_operation_spec.rb → spec/graphql_response/matchers/have_field_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe RSpec::GraphQLResponse, "matcher#have_operation", type: :graphql do
+RSpec.describe RSpec::GraphQLResponse, "matcher#have_field", type: :graphql do
   graphql_operation <<-GQL
     query CharacterList {
       characters {
@@ -12,14 +12,14 @@
     it "is valid" do
       expect(response).to_not have_errors
 
-      expect(response).to have_operation(:characters)
+      expect(response).to have_field(:characters)
     end
 
     it "is invalid when negated" do
       expect(response).to_not have_errors
 
       expect { 
-        expect(response).to_not have_operation(:characters)
+        expect(response).to_not have_field(:characters)
       }.to raise_error(/Expected not to find operation result named characters/)
     end
   end
@@ -29,14 +29,14 @@
       expect(response).to_not have_errors
 
       expect {
-        expect(response).to have_operation(:operation_not_present)
+        expect(response).to have_field(:operation_not_present)
       }.to raise_error(/Expected to find operation result named operation_not_present/)
     end
 
     it "is valid when negated" do
       expect(response).to_not have_errors
 
-      expect(response).to_not have_operation(:operation_not_present)
+      expect(response).to_not have_field(:operation_not_present)
     end
   end
 end

spec/graphql_response/validators/have_operation_negated_spec.rb → spec/graphql_response/validators/have_field_negated_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe RSpec::GraphQLResponse, "#have_operation validator", type: :graphql do
+RSpec.describe RSpec::GraphQLResponse, "#have_field validator", type: :graphql do
   graphql_operation <<-GQL
     query CharacterList {
       characters {
@@ -11,7 +11,7 @@
   let(:operation_name) { nil }
 
   subject(:result) do
-    validator = RSpec::GraphQLResponse.validator :have_operation
+    validator = RSpec::GraphQLResponse.validator :have_field
     validator.validate_negated(response, operation_name: operation_name)
   end
 

spec/graphql_response/validators/have_operation_spec.rb → spec/graphql_response/validators/have_field_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe RSpec::GraphQLResponse, "#have_operation validator", type: :graphql do
+RSpec.describe RSpec::GraphQLResponse, "#have_field validator", type: :graphql do
   graphql_operation <<-GQL
     query CharacterList {
       characters {
@@ -11,7 +11,7 @@
   let(:operation_name) { nil }
 
   subject(:result) do
-    validator = RSpec::GraphQLResponse.validator :have_operation
+    validator = RSpec::GraphQLResponse.validator :have_field
     validator.validate(response, operation_name: operation_name)
   end