rspec-graphql_response 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352fd084b9379469d7b4f71c86cfe94ea90172047c61c1ea2d20dced4bc85026
-  data.tar.gz: 7eccaeb870a708fe43f2b0891a45d703b7d1fd64901efddd5323a27b6d87a77f
+  metadata.gz: 7104f657d559b5617486876024bc92367f177b94734ac8f224452cf6e4917f3e
+  data.tar.gz: f9c0df4206c1dd6c02f7b744b5edaa91c877a2e0be5c1ee235d6a05e0c3df9f0
 SHA512:
-  metadata.gz: 83ebc95cd8c33beb6f62df67c9eb7a6846f820ca7bbc2c8412aadd0b4ceb0098449c23aeaf599bcaf65db6ddd4f4d92d2029a46e5a83c2b463f26e826040156c
-  data.tar.gz: 876549c88363f4e330bdb01416940116bb7a997ee7f22d2864a0d8c7a55b9310df7198b135d4bc1d655b22adecfc02df09e89feb7e173f5febfd4f2a0bd73f9a
+  metadata.gz: 71ef7903cb4b46d5588b03402a5c3e44d6c61e13b898f8269f44ec3acd3b976cd3c77f921b68fc050dab0a20700f5846007c79cacfef8acfe1516f6af1a2045d
+  data.tar.gz: e9bbad747532e9fca29ed6e0bf8b4299be8896344f9541527bff4f71242ecfe4117f02d9946d0aece0215ec1952ce391bb5bfe74eccce747c167da52fe06acb2

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    rspec-graphql_response (0.1.0)
-      rspec (~> 3.10)
+    rspec-graphql_response (0.5.0)
+      graphql (>= 1.0)
+      rspec (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    attr_extras (6.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    graphql (1.12.4)
+    graphql (1.12.6)
     method_source (1.0.0)
+    optimist (3.0.1)
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -32,17 +37,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    super_diff (0.6.1)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
-  graphql (~> 1.12)
   pry (~> 0.14)
   pry-byebug (~> 3.8)
   rake (>= 12.0)
   rspec-graphql_response!
+  super_diff (~> 0.6)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -30,40 +30,45 @@ Or install it yourself as:
 
 ## Full Documentation
 
-* [Release Notes](/RELEASE_NOTES.md)
-* [Upgrade Guide](/UPGRADE.md)
+- [Release Notes](/RELEASE_NOTES.md)
+- [Upgrade Guide](/UPGRADE.md)
 
 The full documentation for RSpec::GraphQLResponse can be found in the `/docs` folder.
 
 Configuration:
-* [RSpec::GraphQLResponse.configure](/docs/configuration.md)
-* [Spec Type :graphql](/docs/graphql_spec_type.md)
+
+- [RSpec::GraphQLResponse.configure](/docs/configuration.md)
+- [Spec Type :graphql](/docs/graphql_spec_type.md)
 
 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_errors](/docs/have_errors.md) - validates errors, or lack of, on 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:
-* [execute_graphql](/docs/execute_graphql.md) - executes a graphql call with the registered schema, query, variables and context
-* [graphql_query](/docs/execute_graphql.md) - the query to execute
-* [graphql_variables](/docs/execute_graphql.md) - a hash of variables the query expects
-* [graphql_context](/docs/execute_graphql.md) - the `context` of a query or mutation's resolver
+
+- [graphql_operation](/docs/execute_graphql.md) - the operation to execute (i.e query or mutation)
+- [graphql_variables](/docs/execute_graphql.md) - a hash of variables the query expects
+- [graphql_context](/docs/execute_graphql.md) - the `context` of a query or mutation's resolver
 
 Spec Helper Methods:
-* [response](/docs/response.md) - the response, as JSON, of the executed graphql query
-* [operation](/docs/operation.md) - retrieves the results of a named operation from the GraphQL response
+
+- [execute_graphql](/docs/execute_graphql.md) - executes a graphql call with the registered schema, query, variables and context
+- [response](/docs/response.md) - the response, as JSON, of the executed graphql query
+- [response_data](/docs/response_data.md) - digs through the graphql response to return data from the specified node(s)
 
 API / Development
-* [.add_matcher](/docs/add_matcher.md) - add a custom RSpec matcher to the GraphQLResponse matchers
-* [.add_validator](/docs/add_validator.md) - add a custom validator to be used by the custom matchers
-* [.add_helper](/docs/add_helper.md) - add helper methods to your specs, made avialable in `it` or `describe` / `context` blocks
+
+- [.add_matcher](/docs/add_matcher.md) - add a custom RSpec matcher to the GraphQLResponse matchers
+- [.add_validator](/docs/add_validator.md) - add a custom validator to be used by the custom matchers
+- [.add_helper](/docs/add_helper.md) - add helper methods to your specs, made avialable in `it` or `describe` / `context` blocks
 
 ## Getting Started
 
-There are only a couple of bits you need to get started: 
+There are only a couple of bits you need to get started:
 
-* configuration of a GraphQL Schema in [`RSpec::GraphQLResponse.configure`](/docs/configuration.md)
-* the inclusion of [`type: :graphql`](/docs/graphql_spec_type.md) in your `RSpec.describe` call
+- configuration of a GraphQL Schema in [`RSpec::GraphQLResponse.configure`](/docs/configuration.md)
+- the inclusion of [`type: :graphql`](/docs/graphql_spec_type.md) in your `RSpec.describe` call
 
 ```ruby
 RSpec::GraphQLResponse.configure do |config|
@@ -114,7 +119,7 @@ in your specs.
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
-  graphql_query <<-GQL
+  graphql_operation <<-GQL
     query ListCharacters{
       characters {
         id
@@ -138,7 +143,7 @@ way. The reduce this, `RSpec::GraphQLResponse` provides a built-in `response` he
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
-  graphql_query <<-GQL
+  graphql_operation <<-GQL
     query ListCharacters{
       characters {
         id
@@ -157,15 +162,15 @@ 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
-  graphql_query <<-GQL
+  graphql_operation <<-GQL
     query ListCharacters{
       characters {
         id
@@ -175,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,17 @@ 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
+
+The helper `graphql_query` was renamed to `graphql_operation` to better communicate the use of the helper. Naming the helper with `_query` lead to an association that its use was meant for GraphQL query operations and could not also be used for a mutation.
+
 ## v0.2.0 - GraphQL Configuration DSL and Refactorings
 
 Misc changes and corrections, some new features, and generally trying to create a more robust
@@ -11,13 +22,13 @@ and usable experience, right out of the box.
 
 ### New Features
 
-* Significantly improved documentation
-* `have_operation` matcher
-* GraphQL configuration DSL
-  * `graphql_query`
-  * `graphql_variables`
-  * `graphql_context`
-* Describe/Context level RSpec helper methods via `.add_context_helper` DSL
+- Significantly improved documentation
+- `have_operation` matcher
+- GraphQL configuration DSL
+  - `graphql_query`
+  - `graphql_variables`
+  - `graphql_context`
+- Describe/Context level RSpec helper methods via `.add_context_helper` DSL
 
 ### Breaking Changes
 
@@ -32,8 +43,8 @@ Lots of misc bug fixes, including caching of values, ensuring things work in nes
 
 Early beta work to get this out the door and begin adoption
 
-* `have_errors` matcher
-* `operation` helper
-* `response` helper
-* `execute_graphql` helper
-* DSL for adding custom matchers, validators, and helpers
+- `have_errors` matcher
+- `operation` helper
+- `response` helper
+- `execute_graphql` helper
+- DSL for adding custom matchers, validators, and helpers

data/UPGRADE.md

@@ -1,8 +1,12 @@
 # Upgrade Guide
 
+## v0.3.0 to v0.4.0
+
+There is a breaking change between v0.3.0 and v0.4.0 where the helper `graphql_query` was renamed to `graphql_operation`. In order to migrate to v0.4.0 all references to `graphql_query` can be replaced with `graphql_operation`.
+
 ## v0.1.0 to v0.2.0
 
-There is a breaking change between v0.1.0 and v0.2.0 regarding the configuration of graphql queries, variables and context. 
+There is a breaking change between v0.1.0 and v0.2.0 regarding the configuration of graphql queries, variables and context.
 Previously, you defined these three items with `let` in rspec:
 
 ```ruby

data/docs/add_helper.md

@@ -23,7 +23,7 @@ it "does stuff" do
 end
 ```
 
-It's not a huge difference, but when you consider how well the `operation` method handles `nil` and 
+It's not a huge difference, but when you consider how well the `operation` method handles `nil` and
 operation results that are not found, it's well worth the few lines of savings.
 
 There are many other helpers available for your test suites, as well. Be sure to check the full
@@ -51,15 +51,14 @@ RSpec::GraphQLResponse.add_helper :operation do |operation_name|
 end
 ```
 
-In this example, the `response` helper is used, which guarantees the graphql has been executed and a response 
+In this example, the `response` helper is used, which guarantees the graphql has been executed and a response
 is available, assuming there were no exceptions preventing that.
 
 ## Add a Context Helper
 
 In addition to Spec level helpers, RSpec::GraphQLResponse allows you to add custom helpers at the context
 level. This means you can add configuration and other bits that can be called outside of an `it` block.
-The existing `graphql_query` and other DSL methods for configuring graphql calls are a great example of
-context level helpers.
+The existing `graphql_operation` and other DSL methods for configuring graphql calls are a great example of context level helpers.
 
 To create a context helper, call `RSpec::GraphQLResponse.add_context_helper(name, &helper_block)`. The params
 are the same as `.add_helper`, but the resulting method will be made available in `describe` and `context`
@@ -73,7 +72,7 @@ end
 
 In this simple example, a method called `my_setting` is created, and it stores a value in the instance variable
 `@my_setting`. This takes advantage of RSpec's native ability to handle instance variables in describe and
-context blocks, allowing the variable to exist withing the hierarchy of objects for a given spec. 
+context blocks, allowing the variable to exist withing the hierarchy of objects for a given spec.
 
 With that defined, it can be used within a spec:
 

data/docs/execute_graphql.md

@@ -5,7 +5,10 @@ methods for configuring the query.
 
 ```ruby
 RSPec.describe Cool::Stuff, type: :graphql do
-  graphql_query <<-GQL
+  let(:user) { create(:graphql_user) }
+  let(:search_name) { "Pet" }
+
+  graphql_operation <<-GQL
     query SomeThing($name: String) {
       characters(name: $name) {
         id
@@ -13,14 +16,18 @@ RSPec.describe Cool::Stuff, type: :graphql do
       }
     }
   GQL
-  
-  graphql_variables {
-    name: "Jam"
-  }
 
-  grapql_context {
-    current_user: "some user or whatever you need"
-  }
+  graphql_variables do
+    {
+      name: search_name
+    }
+  end
+
+  grapql_context do
+    {
+      current_user: user
+    }
+  end
 
   it "executes and does the thing with the vars and context" do
     # ... expect things here
@@ -30,7 +37,7 @@ end
 
 ## Available Configuration Methods
 
-### `graphql_query`
+### `graphql_operation`
 
 A string - most commonly a ruby heredoc - for the graphql query to execute
 

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.
@@ -7,7 +7,7 @@ retrieving the operation's results.
 
 ```ruby
 RSpec.describe My::Characters, type: :graphql do
-  graphql_query <<-GQL
+  graphql_operation <<-GQL
     query CharacterList {
       characters {
         id
@@ -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
@@ -28,7 +28,7 @@ end
 
 ```ruby
 RSpec.describe My::Characters, type: :graphql do
-  graphql_query <<-GQL
+  graphql_operation <<-GQL
     query CharacterList {
       characters {
         id
@@ -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/docs/operation.md

@@ -1,38 +1,3 @@
 # Using the `operation` helper
 
-The `operation` helper will dig through a response to find a data
-structure that looks like, 
-
-```ruby
-{
-  "data" => {
-    operation_name
-  }
-}
-```
-
-## Basic Use
-
-```ruby
-it "has characters" do
-  characters = operation(:characters)
-
-  expect(character).to include(
-    { id: 1, name: "Jam" },
-    # ...
-  )
-end
-```
-
-## Handling Nil
-
-If there is no `"data"` or no named operation for the name supplied, the
-`operation` helper will return `nil`
-
-```ruby
-it "returns nil if operation doesn't exist" do
-  character = operation(:something_that_does_not_exist)
-
-  expect(operation).to be_nil
-end
-```
+Deprecated. See [response_data](response_data.md) instead.

data/docs/response.md

@@ -1 +1 @@
-# Check the GraphQL Response with Helper `response`
+# The GraphQL Response, via Helper `response`

data/docs/response_data.md

@@ -0,0 +1,146 @@
+# Using the `response_data` Helper
+
+The `response_data` helper will dig through a graphql response, through
+the outer hash, into the response data for an operation, and through any
+and all layers of hash and array. 
+
+## Syntax
+
+```ruby
+response_data *[dig_pattern]
+```
+
+Data returned via this helper will assume a `"data" => ` key at the root of
+the `response` object. This root does not need to be specified in the list
+of attributes for the `dig_pattern`.
+
+### Params
+
+* `*[dig_pattern]` - an array of attributes (`:symbol`, `"string"`, or `key: :value` pair) that describes
+the data structure to dig through, and the final data set to retrieve from the graphql response.
+
+#### dig_pattern
+
+Each attribute added to the `dig_pattern` represents an attribute at the given level of the
+data structure, in numeric order from left to right. The first attribute provides will dig into
+that attribute at the first level of data (just below the `"data" =>` key). The second attribute
+will dig through data just below that first level, etc. etc. etc.
+
+For example, with a data structure as shown below, in "Basic Use", you could specifiy these
+attributes for the dig pattern:
+
+* :characters
+* :name
+
+Like this:
+
+```ruby
+response_data :characters, :name
+```
+
+This dig pattern will find the `"characters"` key just below `"data"`, then iterate through
+the array of characters and retrieve the `"name"` of each character.
+
+For more details and options for the dig pattern, see the examples below.
+
+## Basic Use
+
+A `response` data structure may look something like the following.
+
+```ruby
+{
+  "data" => {
+    "characters" => [
+      { "id" => "1", "name" => "Jam" },
+      { "id" => "2", "name" => "Redemption" },
+      { "id" => "3", "name" => "Pet" }
+    ]
+  }
+}
+```
+
+The `response_data` helper will dig through to give you simplified
+results that are easier to verify.
+
+For example, if only the names of the characters need to be checked:
+
+```ruby
+response_data :characters, :name
+
+# => ["Jam", "Redemption", "Pet"]
+```
+
+Or perhaps only the name for 2nd character is needed:
+
+```ruby
+response_data {characters: [1]}, :name
+
+# => "Redemption"
+```
+
+## List Every Item in an Array
+
+Many responses from a graphql call will include an array of data somewhere
+in the data structure. If you need to return all of the items in an array,
+you only need to specify that array's key:
+
+```ruby
+it "has characters" do
+  characters = response_data(:characters)
+
+  expect(character).to include(
+    { id: 1, name: "Jam" },
+    # ...
+  )
+end
+```
+
+## Dig a Field From Every Item in an Array
+
+When validation only needs to occur on a specific field for items found in
+an array, there are two options.
+
+1. Specify a list of fields as already shown
+2. change the array's key to a hash and provide a `:symbol` wrapped in an array as the value
+
+The first option was already shown in the Basic Use section above. 
+
+```ruby
+response_data :characters, :name
+
+# => ["Jam", "Redemption", "Pet"]
+```
+
+For the second option, the code would look like this:
+
+```ruby
+response_data characters: [:name]
+
+# => ["Jam", "Redemption", "Pet"]
+```
+
+Both of these options are functionaly the same. The primary difference will be
+how you wish to express the data structure in your code. Changing the list of
+attributes to a hash with an array wrapping the value will provide a better
+indication that an array is expected at that point in the data structure.
+
+## Dig Out an Item By Index, From an Array
+
+There may be times when only a single piece of a returned array needs to be
+validated. To handle this, switch the key of the array to a hash, as in the
+previous example. Rather than specifying a child node's key in the value, though,
+specify the index of the item you wish to extract.
+
+```ruby
+response_data characters: [1]
+```
+
+This will return the character at index 1, from the array of characters.
+
+## Handling Nil
+
+If there is no data the key supplied, the helper will return `nil`
+
+```ruby
+response_data(:something_that_does_not_exist) #=> nil
+```

data/lib/rspec/graphql_response.rb

@@ -1,5 +1,6 @@
 require "rspec"
 
+require_relative "graphql_response/dig_dug/dig_dug"
 require_relative "graphql_response/version"
 require_relative "graphql_response/configuration"
 require_relative "graphql_response/validators"

data/lib/rspec/graphql_response/dig_dug/dig_dug.rb

@@ -0,0 +1,83 @@
+module RSpec
+  module GraphQLResponse
+    class DigDug
+      attr_reader :dig_pattern
+
+      def initialize(*dig_pattern)
+        @dig_pattern = parse_dig_pattern(*dig_pattern)
+      end
+
+      def dig(data)
+        dig_data(data, dig_pattern)
+      end
+
+      private
+
+      def dig_data(data, patterns)
+        return data if patterns.nil?
+        return data if patterns.empty?
+
+        node = patterns[0]
+        node_key = node[:key]
+        node_key = node_key.to_s if node_key.is_a? Symbol
+        node_value = node[:value]
+
+        if node[:type] == :symbol
+          result = dig_symbol(data, node_key)
+        elsif node[:type] == :array
+          if data.is_a? Hash
+            child_data = data[node_key]
+            result = dig_symbol(child_data, node_value)
+          elsif data.is_a? Array
+            result = data.map { |value|
+              child_data = value[node_key]
+              dig_symbol(child_data, node_value)
+            }.compact
+          else
+            result = data
+          end
+        end
+
+        dig_data(result, patterns.drop(1))
+      end
+
+      def parse_dig_pattern(*pattern)
+        pattern_config = pattern.map do |pattern_item|
+          if pattern_item.is_a? Symbol 
+            {
+              type: :symbol,
+              key: pattern_item
+            }
+          elsif pattern_item.is_a? Hash
+            pattern_item.map do |key, value|
+              {
+                type: :array,
+                key: key,
+                value: value[0]
+              }
+            end
+          end
+        end
+
+        pattern_config.flatten
+      end
+
+      def dig_symbol(data, key)
+        key = key.to_s if key.is_a? Symbol
+        return data[key] if data.is_a? Hash
+
+        if data.is_a? Array
+          if key.is_a? Numeric
+            mapped_data = data[key]
+          else
+            mapped_data = data.map { |value| value[key] }.flatten
+          end
+
+          return mapped_data
+        end
+
+        return data
+      end
+    end
+  end
+end

data/lib/rspec/graphql_response/helpers.rb

@@ -6,13 +6,14 @@ module RSpec
 
     def self.add_helper(name, scope: :spec, &helper)
       helper_module = Module.new do |mod|
-        mod.define_method(name) do |*args|
+        mod.define_method(name) do |*args, &block|
           instance_var = "@#{name}".to_sym
 
           if self.instance_variables.include? instance_var
             return self.instance_variable_get(instance_var)
           end
 
+          args << block
           result = self.instance_exec(*args, &helper)
           self.instance_variable_set(instance_var, result)
         end
@@ -20,7 +21,8 @@ module RSpec
 
       RSpec.configure do |config|
         config.after(:each) do
-          helper_module.instance_variable_set(:@result, nil)
+          instance_var = "@#{name}".to_sym
+          helper_module.instance_variable_set(instance_var, nil)
         end
 
         module_method = if scope == :spec
@@ -38,11 +40,11 @@ module RSpec
 end
 
 # describe level helpers
-require_relative "helpers/graphql_query"
-require_relative "helpers/graphql_variables"
 require_relative "helpers/graphql_context"
+require_relative "helpers/graphql_operation"
+require_relative "helpers/graphql_variables"
 
 # spec level helpers
-require_relative "helpers/operation"
-require_relative "helpers/response"
 require_relative "helpers/execute_graphql"
+require_relative "helpers/response"
+require_relative "helpers/response_data"

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

@@ -1,12 +1,17 @@
 RSpec::GraphQLResponse.add_helper :execute_graphql do
   config = RSpec::GraphQLResponse.configuration
 
-  query = get_graphql_query if respond_to? :get_graphql_query
-  query_vars = get_graphql_variables if respond_to? :get_graphql_variables
-  query_context = get_graphql_context if respond_to? :get_graphql_context
+  operation = graphql_operation if respond_to? :graphql_operation
+  operation = self.instance_eval(&graphql_operation) if operation.is_a? Proc
 
-  config.graphql_schema.execute(query, {
-    variables: query_vars,
-    context: query_context
+  operation_vars = graphql_variables if respond_to? :graphql_variables
+  operation_vars = self.instance_eval(&graphql_variables) if operation_vars.is_a? Proc
+  
+  operation_context = graphql_context if respond_to? :graphql_context
+  operation_context = self.instance_eval(&operation_context) if operation_context.is_a? Proc
+
+  config.graphql_schema.execute(operation, {
+    variables: operation_vars,
+    context: operation_context
   })
 end

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

@@ -1,3 +1,3 @@
 RSpec::GraphQLResponse.add_context_helper :graphql_context do |ctx|
-  self.define_method(:get_graphql_context) { ctx }
+  self.define_method(:graphql_context) { ctx }
 end

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

@@ -0,0 +1,3 @@
+RSpec::GraphQLResponse.add_context_helper :graphql_operation do |gql|
+  self.define_method(:graphql_operation) { gql }
+end

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

@@ -1,3 +1,3 @@
 RSpec::GraphQLResponse.add_context_helper :graphql_variables do |vars|
-  self.define_method(:get_graphql_variables) { vars }
+  self.define_method(:graphql_variables) { vars }
 end

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

@@ -0,0 +1,13 @@
+RSpec::GraphQLResponse.add_helper :response_data do |*fields|
+  next nil unless response.is_a? Hash
+
+  response_data = response["data"]
+  next nil if response_data.nil?
+  next nil if response_data.empty?
+
+  fields = fields.compact
+  next response_data if fields.empty?
+
+  dig_dug = RSpec::GraphQLResponse::DigDug.new(*fields)
+  dig_dug.dig(response_data)
+end

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.2.0"
+    VERSION = "0.5.0"
   end
 end

data/rspec-graphql_response.gemspec

@@ -26,10 +26,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "graphql", "~> 1.12"
   spec.add_development_dependency "rake", ">= 12.0"
   spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "pry-byebug", "~> 3.8"
+  spec.add_development_dependency "super_diff", "~> 0.6"
 
-  spec.add_runtime_dependency "rspec", "~>3.10"
+  spec.add_runtime_dependency "rspec", ">= 3.0"
+  spec.add_runtime_dependency "graphql", ">= 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_response
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - River Lynn Bailey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: graphql
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: super_diff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :runtime
+        version: '0.6'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Adds a :graphql rspec type with built-in helpers and matchers for ruby-graphql
   gem responses
 email:
@@ -126,24 +140,26 @@ 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
 - lib/rspec/graphql_response.rb
 - lib/rspec/graphql_response/configuration.rb
+- lib/rspec/graphql_response/dig_dug/dig_dug.rb
 - lib/rspec/graphql_response/helpers.rb
 - lib/rspec/graphql_response/helpers/execute_graphql.rb
 - lib/rspec/graphql_response/helpers/graphql_context.rb
-- lib/rspec/graphql_response/helpers/graphql_query.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/graphql_query.rb

@@ -1,3 +0,0 @@
-RSpec::GraphQLResponse.add_context_helper :graphql_query do |gql|
-  self.define_method(:get_graphql_query) { gql }
-end

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

@@ -1,5 +0,0 @@
-RSpec::GraphQLResponse.add_helper :operation do |name|
-  return nil unless response.is_a? Hash
-
-  response.dig("data", name.to_s)
-end