rspec-graphql_response 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d1e0d86474c6b5f5e99c3d19e3d1645fe35819d5a47a4fd7007af9c9a5700e
-  data.tar.gz: d27339cca95c74fdb174fa0ca6a43116039b449e0b22ef6397ccd76e8eb472d1
+  metadata.gz: 647c52ffa5ae347bc9c2166bd94af15ee82556d10f37fa5a11a0cf0229d40b31
+  data.tar.gz: a93873e4d4a40a9a4702026321d96d913056188dd51eec86836232add5e7c4b7
 SHA512:
-  metadata.gz: b427ec094b4a8e19865e3d610a14abb32625189f7ea190ca61dbcde61e8582abca4464980e2790bb2d30b8ecbb83912034f4a95bcc1cd8744410328a646ad755
-  data.tar.gz: d0864628a5e6beb9096fe8901f67dd6f75d824af26631e1b66ea97894bd30da4061f6ceb25ffc692461a1e54a50f7e7c56405f89cce6275e919d624c9dd29dc8
+  metadata.gz: 9ad72db1bdd814a65f02cf4ee9a59c9836c452003fe840e9c28903aa805ab0553fcd7afa4558d610c63c5ae1959fea61690f037641bd3fa31b417c378ed1805a
+  data.tar.gz: 46ec7e724d5784feb01e33fbb5024d9c8713ddb8df77a1efb2273f1dd94c2bf8c3658ecb1f11ad9065741119b6e4a71815f9911ba3e87a779caafe97563b2dd8

data/.github/workflows/test.yml

@@ -0,0 +1,14 @@
+name: Test rspec-graphql_response
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: bin/rspec

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# ignore the resulting .gem file from gem build
+rspec-graphql_response*.gem

data/.gituprc

@@ -0,0 +1,128 @@
+# Gitup: Git Update Dance Configuration
+# -------------------------------------
+# configuration for gitup can be set as a default for the current user
+# by adding a ~/.gituprc file with settings
+# 
+# current project or local directory settings can be added in ./.gituprc
+# 
+# the .gituprc file is a valid shell script, loaded every time gitup is
+# run. this means you can add logic, functions, and other calls to the
+# .gituprc file and it will be executed at runtime
+
+
+# GIT CONFIGURATION
+# -----------------
+# Manages the git branch update process for your project
+#
+# GITUP_SKIP_UPDATE:
+#   Whether or not a git update is performed prior to running
+#   the bundle install or db:migrate steps
+#
+#   Options:
+#     0: (default) do not skip the update
+#     1: skip the update
+#
+# GITUP_MERGE_COMMAND:
+#   How to update the local git branch, from the upstream branch.
+#
+#   Options:
+#     rebase:  (default) force a rebase of the upstream branch
+#     merge:   force a merge of the upstream branch
+#     <other>: your own command: `git <other> <remote>/<branch>`
+#
+# GITUP_REMOTE_NAME:
+#   The git remote name to pull from
+#
+#   Default:
+#     origin
+#
+# GITUP_BRANCH_NAME:
+#   The main remote branch name to pull, from which your current
+#   branch will be updated
+#
+#   Default:
+#     development
+#
+# GITUP_GIT_UPDATE_FN:
+#   The method called to update your git branch. Responsible
+#   for handling git pull, git merge or rebase, etc.
+#
+#   Params:
+#     $1: Merge Command
+#     $2: Remote Name
+#     $3: Branch Name 
+#
+#   Default:
+#     GITUP_GIT_UPDATE_FN=__gitup_git_update
+#
+GITUP_SKIP_UPDATE=0
+# GITUP_MERGE_COMMAND=rebase
+GITUP_REMOTE_NAME=origin
+GITUP_BRANCH_NAME=main
+GITUP_GIT_UPDATE_FN=__gitup_git_update
+
+# ADVANCED GIT CONFIGURATION
+# --------------------------
+# This .gituprs file is a full bash script. You can add logic
+# to determine how to update, based on your current branch, etc.
+#
+# Examples:
+#
+#   How to change merge command for specific branches
+#   
+# current git branch
+local branch_name=$(git symbolic-ref -q HEAD)
+
+# remove the `refs/heads/` structure from the name
+branch_name=${branch_name##refs/heads/}
+
+# merge if we're in 'development' branch
+if [[ $branch_name == $GITUP_BRANCH_NAME ]]; then
+  GITUP_MERGE_COMMAND=merge
+else
+  GITUP_MERGE_COMMAND=rebase
+fi
+
+# DEPENDENCY INSTALLATION
+# -----------------------
+# Manage the step installs dependencies, after updating git.
+# For example, run `bundle install` (default) and/or other 
+# commands to keep your project's dependencies up to date.
+#
+# GITUP_SKIP_INSTALL_DEPENDENCIES:
+#   Whether or not to skip the step that runs immediately after 
+#   the git-update completes
+#
+#   Options:
+#     0: (default) do not skip the after_update step
+#     1: skip the after_update step
+#
+# GITUP_INSTALL_DEPENDENCIES_FN:
+#   Function to run after gitup has completed the git update process
+#
+#   Default:
+#     GITUP_INSTALL_DEPENDENCIES_FN=__gitup_install_dependencies
+#
+GITUP_SKIP_INSTALL_DEPENDENCIES=0
+GITUP_INSTALL_DEPENDENCIES_FN=__gitup_install_dependencies
+
+# RUN MIGRATIONS
+# --------------
+# Manage the process of running schema and/or data migrations,
+# after your project's post-git-update function has run
+#
+# GITUP_SKIP_MIGRATIONS:
+#   Whether or not to skip the db:migration steps after the git update
+#
+#   Options:
+#     0: (default) do not skip the db:migration steps
+#     1: skip the db:migration steps
+#
+# GITUP_RUN_MIGRATIONS_FN:
+#   Function to run migrations. Occurs after git update and post-update steps
+#
+#   Default:
+#     GITUP_RUN_MIGRATIONS_FN=__gitup_migrations
+#
+GITUP_SKIP_MIGRATIONS=1
+# GITUP_RUN_MIGRATIONS_FN=__gitup_migrations

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    rspec-graphql_response (0.1.0)
-      rspec
+    rspec-graphql_response (0.4.1)
+      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
-  pry-byebug
-  rake
+  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

@@ -3,6 +3,15 @@
 RSpec::GraphQLResponse provides a series of RSpec matchers, helper methods, and other configuration to help simplify
 the testing of responses from the `graphql-ruby` gem and the `<GraphQLSchemaName>.execute` method.
 
+## "Why Should I Use This?"
+
+There are a number of built-in helper methods and matchers that will allow you to skip the copy & paste work of executing
+a GraphQL Schema `.execute`. Additionally, there are custom matchers and other bits that will help simplify your work in
+validating common peices of a graphql response.
+
+Lastly, the work in this gem is geared toward customization for your own application's needs. Every API call used for building
+the pieces of this gem are available to you, directly, in the `API / Development` documentation, below.
+
 ## Installation
 
 Your app must have `graphql-ruby` and `rspec`. With that done, add this line to your application's Gemfile:
@@ -21,71 +30,60 @@ Or install it yourself as:
 
 ## Full Documentation
 
-The full documentation for RSpec::GraphQLResponse can be found in the `/docs`
-folder.
-
-Custom Matchers:
-* [have_errors matcher](/docs/have_errors.md) - validates errors, or lack of, on
-  the GraphQL response
+- [Release Notes](/RELEASE_NOTES.md)
+- [Upgrade Guide](/UPGRADE.md)
 
-Helper Methods:
-* [operation](/docs/operation.md) - retrieves the results of a named operation
-  from the GraphQL response
+The full documentation for RSpec::GraphQLResponse can be found in the `/docs` folder.
 
-Internal 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
-
-## Configuration
-
-To get things rolling, add a configuration block to your `spec_helper.rb` (or other file that gets included in specs, as
-desired). Within this block, you'll need to provide the GraphQL Schema to use for query execution.
-
-```ruby
-RSpec::GraphQLResponse.configure |config| do
+Configuration:
 
-  config.graphql_schema = MyGraphQLSchema
+- [RSpec::GraphQLResponse.configure](/docs/configuration.md)
+- [Spec Type :graphql](/docs/graphql_spec_type.md)
 
-end
-```
+Custom Matchers:
 
-## Getting Started
+- [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
 
-There are a number of built-in helper methods and matchers that will allow you to skip the copy & paste work of executing
-a GraphQL Schema `.execute`. These include:
+Context / Describe Helper Methods:
 
-Spec types:
+- [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
 
-* `type: :graphql`
+Spec Helper Methods:
 
-Helper methods:
+- [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)
 
-* `execute_graphql`
-* `response`
-* `operation`
+API / Development
 
-Matchers:
+- [.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
 
-* `have_errors`
+## Getting Started
 
-### The `:graphql` Spec Type
+There are only a couple of bits you need to get started:
 
-To use these custom helpers and matchers, you need to specificy `type: :graphql` as part of your spec's description. For exmaple,
+- 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.describe Some::Thing, type: :graphql do
-
-  # ... 
+RSpec::GraphQLResponse.configure do |config|
+  config.graphql_schema = MyGraphQLSchema
+end
 
+RSpec.describe My::Cool::Thing, type: :graphql do
+  # ...
 end
 ```
 
-With this `type` set, your specs will have access to all of the `RSpec::GraphQLResponse` code.
+Beyond these two basic needs, understanding the reason for this gem's existence can be useful in figuring out what the gem
+does, and what methods and options are available.
 
-### Helper Methods
+## How We Got Here
 
 Executing a GraphQL call from RSpec is not the most challening code to write:
 
@@ -121,16 +119,14 @@ in your specs.
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
-  let(:query) do
-    <<-GQL
-      query ListCharacters{
-        characters {
-          id
-          name
-        }
+  graphql_operation <<-GQL
+    query ListCharacters{
+      characters {
+        id
+        name
       }
-    GQL
-  end
+    }
+  GQL
 
   it "executes the query" do
     response = execute_graphql.to_h
@@ -147,16 +143,14 @@ way. The reduce this, `RSpec::GraphQLResponse` provides a built-in `response` he
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
-  let(:query) do
-    <<-GQL
-      query {
-        characters {
-          id
-          name
-        }
+  graphql_operation <<-GQL
+    query ListCharacters{
+      characters {
+        id
+        name
       }
-    GQL
-  end
+    }
+  GQL
 
   it "executes the query" do
     expect(response).to include(
@@ -176,22 +170,20 @@ nested hash checking, use the built-in `operation` method to retrieve the `chara
 
 ```ruby
 RSpec.describe Some::Thing, type: :graphql do
-  let(:query) do
-    <<-GQL
-      query {
-        characters {
-          id
-          name
-        }
+  graphql_operation <<-GQL
+    query ListCharacters{
+      characters {
+        id
+        name
       }
-    GQL
-  end
+    }
+  GQL
 
   it "executes the query" do
     characters = operation(:characters)
 
     expect(characters).to include(
-      # ... 
+      # ...
     )
   end
 end

data/RELEASE_NOTES.md

@@ -0,0 +1,45 @@
+# Release Notes
+
+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.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
+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
+
+### Breaking Changes
+
+This release changes the graphql query, variables and context configuration away from `let` vars
+and into a proper DSL.
+
+### Bug Fixes
+
+Lots of misc bug fixes, including caching of values, ensuring things work in nested contexts, etc.
+
+## v0.1.0 - Initial Release
+
+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