rspec-graphql_response 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647c52ffa5ae347bc9c2166bd94af15ee82556d10f37fa5a11a0cf0229d40b31
-  data.tar.gz: a93873e4d4a40a9a4702026321d96d913056188dd51eec86836232add5e7c4b7
+  metadata.gz: 3d20c225bcb889589108bbd4523938d1788251b035c470c58a558e402e220881
+  data.tar.gz: 97e2843002042b969f022194069e169390167d7b5efaedfcfcc7d78a51cabbd6
 SHA512:
-  metadata.gz: 9ad72db1bdd814a65f02cf4ee9a59c9836c452003fe840e9c28903aa805ab0553fcd7afa4558d610c63c5ae1959fea61690f037641bd3fa31b417c378ed1805a
-  data.tar.gz: 46ec7e724d5784feb01e33fbb5024d9c8713ddb8df77a1efb2273f1dd94c2bf8c3658ecb1f11ad9065741119b6e4a71815f9911ba3e87a779caafe97563b2dd8
+  metadata.gz: 9c832fd141b73dffc2dd85ed9bde975221316cb099e70861e1c050374e63500fa2d2a8a60f032a3a285e078e08d7f49524014a25828d26e4936dd1a3b01ab2d5
+  data.tar.gz: f0aa94ec23124e526097dd60713e4d2846293ec98acfa9dc9d6bbddaed76b9baf737c18962fadcac1f354d9de2cf0bb26782e3125f304ba1c9d004d5894d56bd

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule: { interval: monthly }
+    cooldown: { default-days: 14 }
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule: { interval: monthly }
+    cooldown: { default-days: 14 }
+    groups: { github-actions: { patterns: ["*"] } }

data/.github/workflows/test.yml

@@ -1,14 +1,16 @@
 name: Test rspec-graphql_response
-on:
-  push:
-    branches: [ $default-branch ]
-  pull_request:
+on: [push, pull_request, workflow_dispatch]
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
     steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
       with:
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
-    - run: bin/rspec
+    - run: bin/rspec

data/Gemfile.lock

@@ -1,52 +1,65 @@
 PATH
   remote: .
   specs:
-    rspec-graphql_response (0.4.1)
+    rspec-graphql_response (0.6.0)
       graphql (>= 1.0)
       rspec (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    attr_extras (6.2.4)
-    byebug (11.1.3)
+    attr_extras (7.1.0)
+    base64 (0.3.0)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    graphql (1.12.6)
-    method_source (1.0.0)
-    optimist (3.0.1)
+    diff-lcs (1.6.2)
+    fiber-storage (1.0.1)
+    graphql (2.6.11)
+      base64
+      fiber-storage
+      logger
+    io-console (0.9.4)
+    logger (1.7.0)
+    method_source (1.1.0)
+    optimist (3.2.1)
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    pry (0.14.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.8.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    rake (13.0.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+      reline (>= 0.6.0)
+    pry-byebug (3.12.0)
+      byebug (~> 13.0)
+      pry (>= 0.13, < 0.17)
+    rake (13.4.2)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       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
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    super_diff (0.19.0)
+      attr_extras (>= 6.2.4, < 8)
+      diff-lcs (~> 1.5)
+      patience_diff (~> 1.2)
 
 PLATFORMS
+  aarch64-linux
+  arm64-darwin
   ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.17)
   pry (~> 0.14)
   pry-byebug (~> 3.8)
   rake (>= 12.0)
@@ -54,4 +67,4 @@ DEPENDENCIES
   super_diff (~> 0.6)
 
 BUNDLED WITH
-   1.17.2
+   2.5.22

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:
 
@@ -85,7 +85,7 @@ does, and what methods and options are available.
 
 ## How We Got Here
 
-Executing a GraphQL call from RSpec is not the most challening code to write:
+Executing a GraphQL call from RSpec is not the most challenging code to write:
 
 ```ruby
 let(:query) do
@@ -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,16 @@ 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.6.0 - Ruby 3.2+ required
+
+- **Breaking:** Requires Ruby 3.2 or newer.
+- Fixes keyword argument handling for Ruby 3+ (`execute_graphql` and validators) [#12](https://github.com/testdouble/rspec-graphql_response/issues/12).
+
+## 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/execute_graphql.md

@@ -23,7 +23,7 @@ RSPec.describe Cool::Stuff, type: :graphql do
     }
   end
 
-  grapql_context do
+  graphql_context do
     {
       current_user: user
     }

data/docs/have_errors.md

@@ -18,7 +18,7 @@ Ensure there are no errors in the `response`
 
 ```ruby
 it "should not have errors" do
-  expect(response).to_not have_errors
+  expect(response).not_to have_errors
 end
 ```
 
@@ -37,13 +37,13 @@ Ensure the response does not have a specific number of errors.
 
 ```ruby
 it "should not have 2 errors" do
-  expect(response).to_not have_errors(2)
+  expect(response).not_to have_errors(2)
 end
 ```
 
 ### CAUTION: False Positives
 
-Using `.to have_errors(count)` and especially using `.to_not have_errors(count)` is
+Using `.to have_errors(count)` and especially using `.not_to have_errors(count)` is
 potentially dangerous! 
 
 Your test may be ensuring there are not 2 errors, but the underlying code may fail
@@ -70,13 +70,13 @@ This will ensure the `response["errors"]` contains a "User not found" error mess
 
 ```ruby
 it "does not raise User not found" do
-  expect(response).to_not have_errors.with_messages("User not found")
+  expect(response).not_to have_errors.with_messages("User not found")
 end
 ```
 
 ### Fails if Specified Error Found in Array
 
-The `.to_not` form of `.with_messages` will ensure that none of the error messages
+The `.not_to` form of `.with_messages` will ensure that none of the error messages
 specified are found withing the response.
 
 If, for example the response looks like this:
@@ -94,7 +94,7 @@ a test like this would fail:
 
 ```ruby
 it "looks for specific errors" do
-  expect(response).to_not have_errors.with_messages("User not found", "Some other errors")
+  expect(response).not_to have_errors.with_messages("User not found", "Some other errors")
 end
 ```
 
@@ -104,7 +104,7 @@ messages would be ignored.
 
 ### CAUTION: False Positives
 
-Using `.to_not have_errors.with_messages("Some Message")` is a good way to
+Using `.not_to have_errors.with_messages("Some Message")` is a good way to
 ensure your code is not throwing a specific error message. However, it should
 not be the only expectation against the response. If your code raises any errors
 other than the ones specified, it will result in a passing test but a response

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/execute_graphql.rb

@@ -10,8 +10,9 @@ RSpec::GraphQLResponse.add_helper :execute_graphql do
   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, {
+  config.graphql_schema.execute(
+    operation,
     variables: operation_vars,
     context: operation_context
-  })
+  )
 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/{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/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/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/validators/validation_base.rb

@@ -17,18 +17,18 @@ module RSpec
           end
         end
 
-        def validate(response, *args)
+        def validate(response, *args, **kwargs)
           validate_method = self.class.instance_variable_get(:@validate_method)
 
           runner = ValidationRunner.new(self)
-          runner.instance_exec(response, *args, &validate_method)
+          runner.instance_exec(response, *args, **kwargs, &validate_method)
         end
 
-        def validate_negated(response, *args)
+        def validate_negated(response, *args, **kwargs)
           validate_negated_method = self.class.instance_variable_get(:@validate_negated_method)
 
           runner = ValidationRunner.new(self)
-          runner.instance_exec(response, *args, &validate_negated_method)
+          runner.instance_exec(response, *args, **kwargs, &validate_negated_method)
         end
 
         def failure_message(type)

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/version.rb

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

data/rspec-graphql_response.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
+  spec.required_ruby_version = ">= 3.2"
+
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", ">= 12.0"
   spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "pry-byebug", "~> 3.8"

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_response
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - River Lynn Bailey
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,12 +101,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".gituprc"
 - ".pryrc"
 - ".rspec"
-- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -140,7 +125,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 +137,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
@@ -170,7 +154,6 @@ homepage: https://github.com/testdouble/rspec-graphql_response
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,15 +161,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Verify ruby-graphql responses with a :graphql spec type
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.6

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