rspec-graphql-integration 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c4ff53e15be806adbd54539c31cd15f92b7733f6161fbbd3d90b4d827d6d23
-  data.tar.gz: '0780649082510a767cc3bf76225539837a1f0bb4caef92b5f610406b7567d5de'
+  metadata.gz: c741c1c9dcf41ac20bad890effdfde5ffa121b63b60f6704f07c0638a6001e6e
+  data.tar.gz: 74742a1424ec5ff2587bf945eab4cc5bf8ea059552da4f9b61ef01676b284477
 SHA512:
-  metadata.gz: 26c78cddba206449f656a17f8ec4e0fe4edf6527b1104be5fd490a8e785be56bec083b2f8d21c155c696b201989a0036898c05f59b3576de3f2e0ba1189c2e66
-  data.tar.gz: a6ae1678e9c113928c98c3c45cd3e7ef33aa432cd9a03eb2ceedc80aa350fd8d1e44d2f77417eae5d5925b36ebdc69b386dedae9b89b595b311274ca5ca7e78f
+  metadata.gz: 1dc6131393b96403f4054cb9a75c9d44c00a23dc6e5b101525290f1ba9f55d05b8ac4e3d071df262c14f53c4508d7a6f72357a10ca30eb611e1ad760fa3aa7bd
+  data.tar.gz: c6ed7377e513b4e12589f0ae8f1986bbedfbe8c43c31e773427e7b96926089ecac242b930cab4c858994b001776625e34af078b2fb56e2fed42931884b8acebb

data/lib/rspec/graphql_integration/configuration.rb

@@ -4,6 +4,7 @@ module RSpec
   module GraphqlIntegration
     def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength
       config.add_setting(:graphql_schema_class, default: nil)
+      config.add_setting(:graphql_put_files_in_folder, default: false)
 
       config.include(RSpec::GraphqlIntegration::Matchers::DeepEq, type: :graphql)
       config.include(RSpec::GraphqlIntegration::Matchers::MatchGraphqlResponse, type: :graphql)

data/lib/rspec/graphql_integration/matchers/deep_eq.rb

@@ -2,12 +2,10 @@ module RSpec
   module GraphqlIntegration
     module Matchers
       ##
-      # This matcher recursively compares nested Ruby Hashes and Arrays while ignoring
+      # This helper method recursively compares nested Ruby Hashes and Arrays while ignoring
       # the order of elements in Arrays.
       module DeepEq
-        extend RSpec::Matchers::DSL
-
-        matcher(:deep_eq) { |expected| match { |actual| deep_eq?(actual, expected) } }
+        module_function
 
         def deep_eq?(actual, expected)
           return arrays_deep_eq?(actual, expected) if expected.is_a?(Array) && actual.is_a?(Array)
@@ -20,8 +18,8 @@ module RSpec
         def arrays_deep_eq?(actual, expected)
           expected = expected.clone
 
-          actual.each do |array|
-            index = expected.find_index { |element| deep_eq?(array, element) }
+          actual.each do |actual_array|
+            index = expected.find_index { |expected_array| deep_eq?(actual_array, expected_array) }
             return false if index.nil?
 
             expected.delete_at(index)

data/lib/rspec/graphql_integration/matchers/match_graphql_response.rb

@@ -1,3 +1,5 @@
+require "json"
+
 module RSpec
   module GraphqlIntegration
     module Matchers
@@ -7,104 +9,239 @@ module RSpec
         extend RSpec::Matchers::DSL
 
         ##
-        # This error is thrown when a variable is missing that is required for
-        # the GraphQL response matcher.
-        class TestVariableMissing < ArgumentError
-          def initialize(variable_name, example_value)
+        # This error is raised when the schema class is not set in the RSpec configuration.
+        class SchemaNotSetError < StandardError
+          def initialize
             super <<~TEXT
-              Test variable #{variable_name} is missing.
+              Please define
+
+                config.graphql_schema_class
 
-              Please define it, e.g. with:
-              let(:#{variable_name}) { #{example_value} }
+              in your spec_helper.rb
             TEXT
           end
         end
 
         ##
-        # Defines the required variables as a hash for a test that uses
-        # the GraphQL response matcher.
-        #
-        # Key is the variable name, value is an example value.
-        REQUIRED_TEST_VARIABLES = { test_dir: "__FILE__" }.freeze
+        # This error is thrown if neither the default request file is present nor
+        # the request_file_overwrite variable is set in a test.
+        class DefaultRequestFileMissing < StandardError
+          def initialize(default_request_file)
+            super <<~TEXT
+                No default request file found for this test.
+
+                Please create either a default request file:
+                #{default_request_file}
+
+                or define a file with the request_file_overwrite variable:
+                let(:request_file_overwrite) { File.join(File.dirname(__FILE__), "my_request_file.graphql") }
+              TEXT
+          end
+        end
+
+        ##
+        # This error is thrown if neither the default request file is present nor
+        # the response_file_overwrite variable is set in a test.
+        class DefaultResponseFileMissing < StandardError
+          def initialize(default_response_file)
+            super <<~TEXT
+                No default response file found for this test.
+
+                Please create either a default response file:
+                #{default_response_file}
+
+                or define a file with the response_file_overwrite variable:
+                let(:response_file_overwrite) { File.join(File.dirname(__FILE__), "my_response_file.graphql") }
+              TEXT
+          end
+        end
 
         matcher(:match_graphql_response) do |_expected| # rubocop:disable Metrics/BlockLength
           match do |_actual|
-            check_variables!
+            # expected_response needs to be loaded first because it might contain variables
+            # that are required in the request and that aren't loaded yet. Such variables
+            # could be database objects that could be created while loading the response.
+            expected_response
 
-            # We need to test the responses with be_deep_equal so that we ignore
+            # We need to test the responses with DeepEq so that we ignore
             # the order in nested hashes.
-            expect(actual_response).to deep_eq(expected_response)
-          rescue RSpec::Expectations::ExpectationNotMetError => e
-            @error = e
-            raise
+            DeepEq.deep_eq?(actual_response, expected_response)
           end
 
           # For the failure message, we want to show the diff between the actual and
           # the expected response and the standard eq matcher from RSpec does that best.
           failure_message { expect(actual_response).to eq(expected_response) }
 
-          def check_variables!
-            REQUIRED_TEST_VARIABLES.each do |variable_name, example_value|
-              unless defined?(send(variable_name))
-                raise TestVariableMissing.new(variable_name, example_value)
+          ##
+          # Loads the response file and substitutes the variables in the response file.
+          def expected_response
+            @expected_response ||=
+              begin
+                expected_response =
+                  load_response(
+                    response_file,
+                    defined?(response_variables) ? response_variables : {},
+                  )
+
+                expected_response = [expected_response] unless expected_response.is_a?(Array)
+
+                expected_response
               end
+          end
+
+          ##
+          # Executes the query with the context and the variables against the schema and
+          # returns the response.
+          def actual_response
+            @actual_response ||=
+              begin
+                response =
+                  schema_class.execute(
+                    File.read(request_file),
+                    context: defined?(context) ? context : {},
+                    variables: defined?(request_variables) ? request_variables : {},
+                  )
+
+                response.values
+              end
+          end
+
+          ##
+          # This method tries to get the file path for the file that is running the tests.
+          #
+          # The magic of this method can be overwritten by defining:
+          # let(:test_file_overwrite) { __FILE__ }
+          def test_file
+            return test_file_overwrite if defined?(test_file_overwrite)
+
+            caller_location =
+              caller_locations.find { |location| location.path.include?("/spec/graphql") }
+
+            caller_location.path
+          end
+
+          ##
+          # This method defines the folder where the request and response files are stored.
+          #
+          # It's either the folder of the file that is running the tests or a subfolder
+          # named like the test file.
+          def files_folder
+            if RSpec.configuration.graphql_put_files_in_folder
+              test_file.gsub("_spec.rb", "")
+            else
+              File.dirname(test_file)
             end
           end
 
-          def expected_response
-            expected_response = load_response(test_dir, response_template, response_variables)
+          ##
+          # This method tries to get the file path for the request file.
+          #
+          # If the request_file_overwrite variable is set, it uses that.
+          #
+          # raises DefaultRequestFileMissing if no request file is found.
+          def request_file
+            if defined?(request_file_overwrite)
+              return File.join(files_folder, request_file_overwrite)
+            end
 
-            expected_response = [expected_response] unless expected_response.is_a?(Array)
+            default_request_file = File.join(files_folder, default_request_file_name)
 
-            expected_response
+            unless File.exist?(default_request_file)
+              raise DefaultRequestFileMissing, default_request_file
+            end
+
+            default_request_file
           end
 
-          def actual_response
-            response =
-              schema_class.execute(
-                load_query(test_dir, query_file),
-                context: context,
-                variables: defined?(request_variables) ? request_variables : {},
-              )
-
-            response.values
+          ##
+          # The default request file is either called like the test file without _spec
+          # but with .graphql or it's in the subfolder of the test file called "request.graphql".
+          def default_request_file_name
+            if RSpec.configuration.graphql_put_files_in_folder
+              "request.graphql"
+            else
+              test_file.split("/").last.gsub("_spec.rb", ".graphql")
+            end
           end
 
+          ##
+          # This method tries to get the file path for the response file.
+          #
+          # If the response_file_overwrite variable is set, it uses that.
+          #
+          # raises DefaultRequestFileMissing if no response file is found.
+          def response_file
+            if defined?(response_file_overwrite)
+              return File.join(files_folder, response_file_overwrite)
+            end
+
+            default_response_file = File.join(files_folder, default_response_file_name)
+
+            unless File.exist?(default_response_file)
+              raise DefaultResponseFileMissing, default_response_file
+            end
+
+            default_response_file
+          end
+
+          ##
+          # The default response file is either called like the test file without _spec
+          # but with .json or it's in the subfolder of the test file called "response.json".
+          def default_response_file_name
+            if RSpec.configuration.graphql_put_files_in_folder
+              "response.json"
+            else
+              test_file.split("/").last.gsub("_spec.rb", ".json")
+            end
+          end
+
+          ##
+          # This method gets the schema class from the RSpec configuration.
+          #
+          # If schema_class_overwrite is set, it uses that.
+          #
+          # raises SchemaNotSetError if the schema class is not set.
           def schema_class
             # It's possible to overwrite the schema class if an app has multiple schemas.
             return schema_class_overwrite if defined?(schema_class_overwrite)
 
-            if RSpec.configuration.graphql_schema_class.nil? && !Object.const_defined?(:Schema)
-              raise "Please define config.graphql_schema_class in your rails_helper.rb"
-            end
+            raise SchemaNotSetError if RSpec.configuration.graphql_schema_class.nil?
 
             RSpec.configuration.graphql_schema_class
           end
         end
 
-        ##
-        # Loads a query in a GraphQL file.
-        #
-        # Example:
-        # load_query(__FILE__, 'current_user/query.graphql'),
-        def load_query(dir, filename)
-          File.read(File.join(File.dirname(dir), filename))
-        end
-
         ##
         # Loads a response in a JSON file and substitute the passed variables that
         # are surrounded by {{...}} in the file.
         #
         # Example:
         # load_response(
-        #   __FILE__,
-        #   'current_user/response.json',
+        #   "current_user.json",
         #   {
-        #     user_id: user.id,
+        #     user_id: 1,
         #   },
         # )
-        def load_response(dir, filename, variables = {})
-          json_file = File.read(File.join(File.dirname(dir), filename))
+        #
+        # current_user.json:
+        # {
+        #   "data": {
+        #     "currentUser": {
+        #       "id": "{{user_id}}",
+        #     }
+        #   }
+        # }
+        #
+        # Result:
+        # {
+        #   "data": {
+        #     "currentUser": {
+        #     "id": "1",
+        #     }
+        #   }
+        # }
+        def load_response(filename, variables = {})
+          json_file = File.read(filename)
           variables.each { |key, value| json_file.gsub!("\"{{#{key}}}\"", JSON.dump(value)) }
 
           JSON.parse(json_file)

data/lib/rspec/graphql_integration/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module GraphqlIntegration
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql-integration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Gundel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: prettier
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - gundel.peter@gmail.com
@@ -91,14 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An RSpec plugin to simplify integration tests for GraphQL