rspec-graphql_matchers 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b3cd22e67266948bf838945b0330bf050d19c44a4e336cfcd2fec2ad629350f
-  data.tar.gz: 14637372879e218e39922e323614d47426a93370425ed083b94dbec8ed597340
+  metadata.gz: 7dae51bcd93df2cadbbc1f056f27246ffe9fc54fb046cd542bc0461e4caadac8
+  data.tar.gz: dfa65482790aa2ca2ad4d7318679e0b80f13b9ba34c27ca7f7f525e699d7ea4a
 SHA512:
-  metadata.gz: 0bc45acd938927b143eb669e042f5ebcd6758be29602761d31b3101e77d722a66cbc896459f326fa9a44779bd1f6139c0e23b9a0f3d6e31418d6feb90526e58c
-  data.tar.gz: e011517e436af44e654b31847d561c2f588a5a12315d06235dbd2ad0d12770a7281e242d73c13772565c0885dc05ecd0fc7bdb19824365a3c7583c6c5dd74522
+  metadata.gz: 280d14d08215126ef991443f1d786c5d15b2c5c82a34378f17d3c3cd1bd8ab0ab21efd9d1ff9870115c2aeca6d6b4d72dc80aecc760dbd52b6862807440e1f5b
+  data.tar.gz: 571b16fe5f151501313b6a7e94ba32b4f431fa352f2cf11f0ae06af44f1a5e8143a68dc4961cdbcef359c081696391977483e1b65972bb574e2d3ab0029cfa26

data/.github/workflows/rspec.yml

@@ -0,0 +1,41 @@
+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]
+
+jobs:
+  # This workflow contains a single job "rspec"
+  rspec:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        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:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Cache gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          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/.rubocop.yml

@@ -2,31 +2,28 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
 
-Style/Documentation:
-  Enabled: false
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
+Metrics/LineLength:
+  Max: 90
 
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/SpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Include:
     - db/migrate/*.rb
   Enabled: false
 
-Style/Lambda:
+Style/Documentation:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 90
+Style/ClassAndModuleChildren:
+  Enabled: true
+
+Style/Lambda:
+  Enabled: false
 
 Metrics/MethodLength:
   Max: 15

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 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)
 
 -   `accept_argument` matcher accepts underscored argument names and passes even if the actual argument is camel-cased (https://github.com/khamusa/rspec-graphql_matchers/pull/32 thanks to @TonyArra);

data/Gemfile

@@ -1,10 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-graphql_matchers.gemspec
 gemspec
-
-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

data/README.md

@@ -1,4 +1,4 @@
-![Build Status](https://travis-ci.org/khamusa/rspec-graphql_matchers.svg?branch=master)
+![RSpec Status](https://github.com/khamusa/rspec-graphql_matchers/actions/workflows/rspec.yml/badge.svg)
 
 # Rspec::GraphqlMatchers
 
@@ -25,12 +25,7 @@ Where a valid type for the expectation is either:
 
 -   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)`
+    (note the exclamation mark at the end, as required by the [GraphQL specifications](http://graphql.org/).
 
 ## Examples
 
@@ -41,7 +36,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
@@ -97,27 +92,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 +113,7 @@ describe PostType do
 end
 ```
 
-### 5) Test an object's interface implementations:
+### 4) Test an object's interface implementations:
 
 ```ruby
 describe PostType do
@@ -149,12 +124,12 @@ describe PostType do
   end
 
   # Accepts arguments as an array and type objects directly
-  it { is_expected.to implement(GraphQL::Relay::Node.interface) }
+  it { is_expected.to implement(GraphQL::Types::Relay::Node) }
   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 +137,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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rspec/graphql_matchers'

data/lib/rspec/graphql_matchers/accept_argument.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_matcher'
 require_relative './have_a_field_matchers/of_type'
 
@@ -29,8 +31,8 @@ module RSpec
         @actual_argument ||= field_arguments[@expected_camel_arg_name]
         return false if @actual_argument.nil?
 
-        @results = @expectations.select do |matcher|
-          !matcher.matches?(@actual_argument)
+        @results = @expectations.reject do |matcher|
+          matcher.matches?(@actual_argument)
         end
 
         @results.empty?
@@ -57,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
@@ -72,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_matcher'
 
 module RSpec

data/lib/rspec/graphql_matchers/base_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module GraphqlMatchers
     class BaseMatcher
@@ -14,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

@@ -28,9 +28,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
@@ -108,6 +108,10 @@ module RSpec
         when :return_fields then 'have_a_return_field'
         end
       end
+
+      def results
+        @results ||= []
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module GraphqlMatchers
     module HaveAFieldMatchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module GraphqlMatchers
     module HaveAFieldMatchers
@@ -26,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/have_a_field_matchers/with_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module GraphqlMatchers
     module HaveAFieldMatchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module GraphqlMatchers
     module HaveAFieldMatchers

data/lib/rspec/graphql_matchers/implement.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'base_matcher'
 
 module RSpec
   module GraphqlMatchers
     class Implement < BaseMatcher
       def initialize(interfaces)
-        @expected = interfaces.map {|interface| interface_name(interface) }
+        @expected = interfaces.map { |interface| interface_name(interface) }
       end
 
       def matches?(graph_object)

data/lib/rspec/graphql_matchers/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/matchers'
 require 'rspec/graphql_matchers/be_of_type'
 require 'rspec/graphql_matchers/accept_arguments'
@@ -13,13 +15,13 @@ module RSpec
 
     def accept_argument(expected_argument)
       RSpec::GraphqlMatchers::AcceptArgument.new(expected_argument)
-     end
+    end
 
     def accept_arguments(expected_args)
       RSpec::GraphqlMatchers::AcceptArguments.new(expected_args)
     end
 
-    # rubocop:disable Style/PredicateName
+    # rubocop:disable Naming/PredicateName
     def have_a_field(field_name)
       RSpec::GraphqlMatchers::HaveAField.new(field_name)
     end
@@ -34,6 +36,7 @@ module RSpec
       RSpec::GraphqlMatchers::HaveAField.new(field_name, :return_fields)
     end
     alias have_return_field have_a_return_field
+    # rubocop:enable Naming/PredicateName
 
     def implement(*interface_names)
       RSpec::GraphqlMatchers::Implement.new(interface_names.flatten)

data/lib/rspec/graphql_matchers/types_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'graphql'
 
 module RSpec

data/lib/rspec/graphql_matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Rspec
   module GraphqlMatchers
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'.freeze
   end
 end

data/lib/rspec/graphql_matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/graphql_matchers/version'
 require 'rspec/graphql_matchers/matchers'
 require 'rspec/graphql_matchers/types_helper'

data/rspec-graphql_matchers.gemspec

@@ -25,9 +25,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'graphql', '>= 1.8', '< 2.0'
+  spec.add_dependency 'graphql', '>= 1.10.12', '< 2.0'
+  spec.add_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rubocop', '0.71'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  # CodeClimate does not yet support SimpleCov 0.18
+  spec.add_development_dependency 'simplecov', '~>0.17.0'
   spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'rubocop', '0.71'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Samuel Brandão
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,52 +26,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.71'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.71'
+description:
 email:
 - gb.samuel@gmail.com
 executables: []
@@ -95,10 +109,10 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".editorconfig"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -127,7 +141,7 @@ homepage: https://github.com/khamusa/rspec-graphql_matchers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,9 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
-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: []

data/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.3
-script: bundle exec rspec
-matrix:
-  include:
-    - name: "GraphQL 1.9.x"
-      env: GRAPHQL_GEM_VERSION=1.9
-    - name: "GraphQL 1.8.x"
-      env: GRAPHQL_GEM_VERSION=1.8