rspec-graphql_matchers 1.3.1 → 2.0.0.pre.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc59ebc6b348aeab1defdb0057751774ea69653260195b26e9a95363f86430a
-  data.tar.gz: a23a3d725d3e0f2fa8136f7ab9b74efeb411a6e3d0e36e683ae5e99268bb08c6
+  metadata.gz: 984e7d05766f0502ee910f99f522cd81a873b87a9c64ba13b7b1441602c65e51
+  data.tar.gz: d21699dc04dde4843a7d9a109674f8b9d208b35adb39ccfa5a7c2560b209ce4e
 SHA512:
-  metadata.gz: dcd1bd614c785d6f2d5aee1a444c28af584ebf518ecce0706bb7949bc8eb3a0994ddfae953b9b3a3ceecf8a3110df2d91ff0e3dd11756aa3065a9fd9520d9ed3
-  data.tar.gz: e3783cc55413014249911495625eb5f01efef58a5fe3acd9991d0d1a10bad45448a03d63d74ef778819003ee703ddabc936910b71c43ced6d6596bf92db17cbf
+  metadata.gz: 3a1ab2cb2da43f52f17080065d9a4616459a4ce23b39bb3ea39259cc35599e0325c5fd90077d62e785262de19c92512e95c41742d62f5cd8e9372d7a834ce3a2
+  data.tar.gz: 9524fb181330f10eeb4dc7c7eb31888c48a3c97003c7f47579749a00b59672b2148b59d2579ee75a1ea11dcab4626641ce51b7986e714dc177290ea4a0c2ca73

data/.github/workflows/rspec.yml

@@ -2,7 +2,7 @@ name: RSpec
 
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the master branch
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   # This workflow contains a single job "rspec"
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby_version: [ 2.6, 2.7, 3.0 ]
+        ruby_version: [2.6, 2.7, 3.0, 3.1, 3.2]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -36,6 +36,6 @@ jobs:
           key: ${{ runner.os }}-${{ matrix.ruby_version }}-gems-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.ruby_version }}-gems-
-      
+
       - name: Run RSpec
         run: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,44 @@
 # Changelog
 
+## 2.0.0 (April 16th, 2023)
+
+-   Adds compatibility with graphql-ruby 2.0+. If you're still using an earlier version, you should stick to 1.4.x.
+
+### Deprecations
+
+-   The usage of the `#types` helper when writing tests (if you're not including `RSpec::GraphqlMatchers::TypesHelper` anywhere, you shoudn't have to change anything). Use `GraphQL::Types::<TYPE_NAME>` instead
+-   The usage of type instances as expected value for a type comparison is deprecated. Instead,
+    use the string that represents the type specification. Examples:
+
+    ```
+      # Bad - These are deprecated:
+      expect(a_type).to have_a_field(:lorem).of_type(GraphQL::Types::ID)
+      expect(a_type).to have_a_field(:lorem).of_type(Types::MyCustomType)
+
+      # Good - Use these instead
+      expect(a_type).to have_a_field(:lorem).of_type('ID')
+      expect(a_type).to have_a_field(:lorem).of_type('MyCustomType')
+    ```
+
+    The reason behind this change relies on the fact that we should have a decoupling between the
+    internal constants used to define our API and the public names exposed through it. If we test
+    a published API using the internal constants, it is possible to perform breaking changes by
+    renaming the graphql names of our types or entities without actually breaking the tests.
+
+    If we're performing a breaking change to a public API, we want our tests to fail.
+
+## 1.4.0 (April 16th, 2023)
+
+-   Removal of deprecated calls to #to_graphql, replacing them with #to_type_signature that was added in graphql-ruby 1.8.3 (https://github.com/khamusa/rspec-graphql_matchers/pull/43 @RobinDaugherty)
+-   Dropped support for legacy .define API
+-   Dropped support to old relay interfaces
+-   Fixed with_hash_key matcher for newer versions of graphql-ruby
+-   Fixed errors that occured in some edge cases when generating descriptions for accept_argument and have_a_field matchers
+-   Documentations improvement and general cleanup
+-   Dropped support to graphql-ruby versions before 1.10.12.
+
 ## 1.3.1 (Aug 2nd, 2021)
+
 -   Corrected gem dependencies so it properly requires RSpec when loaded (thanks to @itay-grudev)
 
 ## 1.3.0 (May 7th, 2020)

data/Gemfile

@@ -4,11 +4,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-graphql_matchers.gemspec
 gemspec
-
-# rubocop:disable Bundle/DuplicatedGem
-if ENV['GRAPHQL_GEM_VERSION'] == '1.8'
-  gem 'graphql', '~> 1.8.0'
-elsif ENV['GRAPHQL_GEM_VERSION'] == '1.9'
-  gem 'graphql', '~> 1.9.0'
-end
-# rubocop:enable Bundle/DuplicatedGem

data/README.md

@@ -21,16 +21,9 @@ The matchers currently supported are:
 -   `expect(a_field).to be_of_type(valid_type)`
 -   `expect(an_input).to accept_argument(argument_name).of_type(valid_type)`
 
-Where a valid type for the expectation is either:
+Where `valid_type` is a your type signature as a String: `"String!"`, `"Int!"`, `"[String]!"` (note the exclamation mark at the end, as required by the [GraphQL specifications](http://graphql.org/).
 
--   A reference to the actual type you expect;
--   [Recommended] A String representation of a type: `"String!"`, `"Int!"`, `"[String]!"`
-    (note the exclamation mark at the end, as required by the [GraphQL specs](http://graphql.org/).
-
-For objects defined with the legacy `#define` api, testing `:property`, `:hash_key` and _metadata_ is also possible by chaining `.with_property`, `.with_hash_key` and `.with_metadata`. For example:
-
--   `expect(a_graphql_object).to have_a_field(field_name).with_property(property_name).with_metadata(metadata_hash)`
--   `expect(a_graphql_object).to have_a_field(field_name).with_hash_key(hash_key)`
+Please note that using references to type instances is deprecated and will be removed in a future release.
 
 ## Examples
 
@@ -41,7 +34,7 @@ class PostType < GraphQL::Schema::Object
   graphql_name "Post"
   description "A blog post"
 
-  implements GraphQL::Relay::Node.interface
+  implements GraphQL::Types::Relay::Node
 
   field :id, ID, null: false
   field :comments, [String], null: false
@@ -49,9 +42,9 @@ class PostType < GraphQL::Schema::Object
   field :published, Boolean, null: false, deprecation_reason: 'Use isPublished instead'
 
   field :subposts, PostType, null: true do
-    argument :filter, types.String, required: false
-    argument :id, types.ID, required: false
-    argument :isPublished, types.Boolean, required: false
+    argument :filter, String, required: false
+    argument :id, ID, required: false
+    argument :isPublished, Boolean, required: false
   end
 end
 ```
@@ -62,7 +55,7 @@ end
 describe PostType do
   subject { described_class }
 
-  it { is_expected.to have_field(:id).of_type(!types.ID) }
+  it { is_expected.to have_field(:id).of_type("ID!") }
   it { is_expected.to have_field(:comments).of_type("[String!]!") }
   it { is_expected.to have_field(:isPublished).of_type("Boolean") }
 
@@ -97,27 +90,7 @@ describe PostType do
 end
 ```
 
-### 3) For objects defined using the legacy `#define` api, you can also use `with_property`, `with_hash_key` and `with_metadata`:
-
-```ruby
-PostTypeWithDefineApi = GraphQL::ObjectType.define do
-  name "DefinedPost"
-
-  interfaces [GraphQL::Relay::Node.interface]
-
-  field :id, !types.ID, property: :post_id
-  field :comments, !types[types.String], hash_key: :post_comments
-  field :isPublished, admin_only: true
-end
-
-describe PostTypeWithDefineApi do
-  it { is_expected.to have_a_field(:id).of_type('ID!').with_property(:post_id) }
-  it { is_expected.to have_a_field(:comments).with_hash_key(:post_comments) }
-  it { is_expected.to have_a_field(:isPublished).with_metadata(admin_only: true) }
-end
-```
-
-### 4) Test the arguments accepted by a field with `accept_argument` matcher:
+### 3) Test the arguments accepted by a field with `accept_argument` matcher:
 
 ```ruby
 describe PostType do
@@ -138,7 +111,7 @@ describe PostType do
 end
 ```
 
-### 5) Test an object's interface implementations:
+### 4) Test an object's interface implementations:
 
 ```ruby
 describe PostType do
@@ -148,13 +121,11 @@ describe PostType do
     expect(subject).to implement('Node')
   end
 
-  # Accepts arguments as an array and type objects directly
-  it { is_expected.to implement(GraphQL::Relay::Node.interface) }
   it { is_expected.not_to implement('OtherInterface') }
 end
 ```
 
-### 6) Using camelize: false on field names
+### 5) Using camelize: false on field names
 
 By default the graphql gem camelizes field names. This gem deals with it transparently:
 
@@ -162,7 +133,7 @@ By default the graphql gem camelizes field names. This gem deals with it transpa
 class ObjectMessingWithCamelsAndSnakesType < GraphQL::Schema::Object
   graphql_name 'ObjectMessingWithCamelsAndSnakes'
 
-  implements GraphQL::Relay::Node.interface
+  implements GraphQL::Types::Relay::Node
 
   field :me_gusta_los_camellos, ID, null: false
 

data/lib/rspec/graphql_matchers/accept_argument.rb

@@ -59,11 +59,11 @@ module RSpec
       private
 
       def descriptions
-        @results.map(&:description)
+        results.map(&:description)
       end
 
       def failure_messages
-        @results.map(&:failure_message)
+        results.map(&:failure_message)
       end
 
       def field_arguments
@@ -74,6 +74,10 @@ module RSpec
             'matcher. It does not seem to be a valid GraphQL object type.'
         end
       end
+
+      def results
+        @results ||= []
+      end
     end
   end
 end

data/lib/rspec/graphql_matchers/accept_arguments.rb

@@ -40,7 +40,7 @@ module RSpec
 
       def describe_arguments(what_args)
         what_args.sort.map do |arg_name, arg_type|
-          "#{arg_name}(#{arg_type})"
+          "#{arg_name}(#{type_name(arg_type)})"
         end.join(', ')
       end
     end

data/lib/rspec/graphql_matchers/base_matcher.rb

@@ -16,7 +16,7 @@ module RSpec
       end
 
       def type_name(a_type)
-        a_type = a_type.to_graphql if a_type.respond_to?(:to_graphql)
+        a_type = a_type.to_type_signature if a_type.respond_to?(:to_type_signature)
 
         a_type.to_s
       end

data/lib/rspec/graphql_matchers/be_of_type.rb

@@ -17,7 +17,8 @@ module RSpec
       end
 
       def failure_message
-        "expected field '#{member_name(sample)}' to be of type '#{expected}', " \
+        "expected field '#{member_name(sample)}' to " \
+        "be of type '#{type_name(expected)}', " \
         "but it was '#{type_name(sample.type)}'"
       end
 
@@ -28,9 +29,9 @@ module RSpec
       private
 
       def to_graphql(field_sample)
-        return field_sample unless field_sample.respond_to?(:to_graphql)
+        return field_sample unless field_sample.respond_to?(:to_type_signature)
 
-        field_sample.to_graphql
+        field_sample.to_type_signature
       end
     end
   end

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -80,16 +80,16 @@ module RSpec
           field = field_collection[@expected_field_name]
           field ||= field_collection[@expected_camel_field_name]
 
-          field.respond_to?(:to_graphql) ? field.to_graphql : field
+          field.respond_to?(:to_type_signature) ? field.to_type_signature : field
         end
       end
 
       def descriptions
-        @results.map(&:description)
+        results.map(&:description)
       end
 
       def failure_messages
-        @results.map(&:failure_message)
+        results.map(&:failure_message)
       end
 
       def field_collection
@@ -103,11 +103,14 @@ module RSpec
 
       def matcher_name
         case @fields
-        when :fields        then 'have_a_field'
-        when :input_fields  then 'have_an_input_field'
-        when :return_fields then 'have_a_return_field'
+        when :fields then 'have_a_field'
+        when :arguments then 'have_an_input_field'
         end
       end
+
+      def results
+        @results ||= []
+      end
     end
   end
 end

data/lib/rspec/graphql_matchers/have_a_field_matchers/of_type.rb

@@ -5,7 +5,7 @@ module RSpec
     module HaveAFieldMatchers
       class OfType < RSpec::GraphqlMatchers::BeOfType
         def description
-          "of type `#{expected}`"
+          "of type `#{type_name(expected)}`"
         end
 
         def failure_message

data/lib/rspec/graphql_matchers/have_a_field_matchers/with_hash_key.rb

@@ -28,7 +28,11 @@ module RSpec
             return actual_field.hash_key.to_sym if actual_field.hash_key
           end
 
-          actual_field.metadata[:type_class].method_sym
+          if actual_field.respond_to?(:metadata)
+            return actual_field.metadata[:type_class].method_sym
+          end
+
+          actual_field.method_sym
         end
       end
     end

data/lib/rspec/graphql_matchers/matchers.rb

@@ -28,12 +28,12 @@ module RSpec
     alias have_field have_a_field
 
     def have_an_input_field(field_name)
-      RSpec::GraphqlMatchers::HaveAField.new(field_name, :input_fields)
+      RSpec::GraphqlMatchers::HaveAField.new(field_name, :arguments)
     end
     alias have_input_field have_an_input_field
 
     def have_a_return_field(field_name)
-      RSpec::GraphqlMatchers::HaveAField.new(field_name, :return_fields)
+      RSpec::GraphqlMatchers::HaveAField.new(field_name)
     end
     alias have_return_field have_a_return_field
     # rubocop:enable Naming/PredicateName

data/lib/rspec/graphql_matchers/types_helper.rb

@@ -5,8 +5,20 @@ require 'graphql'
 module RSpec
   module GraphqlMatchers
     module TypesHelper
+      class << self
+        extend Gem::Deprecate
+
+        GraphQL::Types.constants.each do |constant_name|
+          klass = GraphQL::Types.const_get(constant_name)
+
+          define_method(constant_name) { klass }
+
+          deprecate constant_name, "GraphQL::Types::#{constant_name}", 2023, 10
+        end
+      end
+
       def types
-        GraphQL::Define::TypeDefiner.instance
+        TypesHelper
       end
     end
   end

data/lib/rspec/graphql_matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Rspec
   module GraphqlMatchers
-    VERSION = '1.3.1'.freeze
+    VERSION = '2.0.0-rc.0'.freeze
   end
 end

data/rspec-graphql_matchers.gemspec

@@ -14,9 +14,6 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/khamusa/rspec-graphql_matchers'
   spec.license = 'MIT'
 
-  # raise 'RubyGems 2.0 or newer is required to protect against public gem ' \
-  #       'pushes.'
-
   spec.files =
     `git ls-files -z`
       .split("\x0")
@@ -25,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '>= 1.8', '< 2.0'
+  spec.add_dependency 'graphql', '~> 2.0'
   spec.add_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
   # CodeClimate does not yet support SimpleCov 0.18

metadata

@@ -1,33 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0.pre.rc.0
 platform: ruby
 authors:
 - Samuel Brandão
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -100,7 +94,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.71'
-description: 
+description:
 email:
 - gb.samuel@gmail.com
 executables: []
@@ -141,7 +135,7 @@ homepage: https://github.com/khamusa/rspec-graphql_matchers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,12 +146,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.
 test_files: []