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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dae51bcd93df2cadbbc1f056f27246ffe9fc54fb046cd542bc0461e4caadac8
-  data.tar.gz: dfa65482790aa2ca2ad4d7318679e0b80f13b9ba34c27ca7f7f525e699d7ea4a
+  metadata.gz: 984e7d05766f0502ee910f99f522cd81a873b87a9c64ba13b7b1441602c65e51
+  data.tar.gz: d21699dc04dde4843a7d9a109674f8b9d208b35adb39ccfa5a7c2560b209ce4e
 SHA512:
-  metadata.gz: 280d14d08215126ef991443f1d786c5d15b2c5c82a34378f17d3c3cd1bd8ab0ab21efd9d1ff9870115c2aeca6d6b4d72dc80aecc760dbd52b6862807440e1f5b
-  data.tar.gz: 571b16fe5f151501313b6a7e94ba32b4f431fa352f2cf11f0ae06af44f1a5e8143a68dc4961cdbcef359c081696391977483e1b65972bb574e2d3ab0029cfa26
+  metadata.gz: 3a1ab2cb2da43f52f17080065d9a4616459a4ce23b39bb3ea39259cc35599e0325c5fd90077d62e785262de19c92512e95c41742d62f5cd8e9372d7a834ce3a2
+  data.tar.gz: 9524fb181330f10eeb4dc7c7eb31888c48a3c97003c7f47579749a00b59672b2148b59d2579ee75a1ea11dcab4626641ce51b7986e714dc177290ea4a0c2ca73

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # 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)

data/README.md

@@ -21,11 +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 specifications](http://graphql.org/).
+Please note that using references to type instances is deprecated and will be removed in a future release.
 
 ## Examples
 
@@ -44,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
 ```
@@ -57,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") }
 
@@ -123,8 +121,6 @@ describe PostType do
     expect(subject).to implement('Node')
   end
 
-  # Accepts arguments as an array and type objects directly
-  it { is_expected.to implement(GraphQL::Types::Relay::Node) }
   it { is_expected.not_to implement('OtherInterface') }
 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/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
 

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -103,9 +103,8 @@ 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
 

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/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.4.0'.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.10.12', '< 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0.pre.rc.0
 platform: ruby
 authors:
 - Samuel Brandão
@@ -14,20 +14,14 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.12
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.12
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -152,9 +146,9 @@ 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.3.7
 signing_key: