rspec-graphql_matchers 1.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95bbde7e6185bd3338294aa487a1f3cfaa794e2f94203f610d3c23f43577a858
-  data.tar.gz: de25f9532825e473237eab0d711d2991b5553a01749e355d5479d98b5c9b0ce8
+  metadata.gz: cfc59ebc6b348aeab1defdb0057751774ea69653260195b26e9a95363f86430a
+  data.tar.gz: a23a3d725d3e0f2fa8136f7ab9b74efeb411a6e3d0e36e683ae5e99268bb08c6
 SHA512:
-  metadata.gz: 98947628be39f759fadce2d0febff1761bf7027367bd82d402e9516e4f445d1eff3400bf1de485379949d1bb04a663d6c49e21cc40c293df1b5e8d3249cdaa22
-  data.tar.gz: 2bac7a4a9d4e1355da652cdd07b643c5741a7cfcc57bc7b4dfb1bce85bb0586b2f9c8072b9030bfecb8a84fbf91eef6c81f37b1d12fd14f821c088a55d54f04b
+  metadata.gz: dcd1bd614c785d6f2d5aee1a444c28af584ebf518ecce0706bb7949bc8eb3a0994ddfae953b9b3a3ceecf8a3110df2d91ff0e3dd11756aa3065a9fd9520d9ed3
+  data.tar.gz: e3783cc55413014249911495625eb5f01efef58a5fe3acd9991d0d1a10bad45448a03d63d74ef778819003ee703ddabc936910b71c43ced6d6596bf92db17cbf

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 ]
+
+    # 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,12 +1,20 @@
 # Changelog
 
-### Breaking changes
+## 1.3.1 (Aug 2nd, 2021)
+-   Corrected gem dependencies so it properly requires RSpec when loaded (thanks to @itay-grudev)
 
-### Deprecations
+## 1.3.0 (May 7th, 2020)
 
-### New features
+-   `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);
+-   `have_a_field` matcher accepts `.with_deprecation_reason` (https://github.com/khamusa/rspec-graphql_matchers/pull/34 thanks to @TonyArra).
 
-### Bug fixes
+## 1.2.1 (March 31st, 2020)
+
+-   Fixed issue causing the last release to break expectations against snake_cased fields (fixes https://github.com/khamusa/rspec-graphql_matchers/issues/30).
+
+## 1.2 (Feb 6th, 2020)
+
+-   Added support to underscored arguments in have_field (https://github.com/khamusa/rspec-graphql_matchers/pull/29 thanks to @makketagg)
 
 ## 1.1 (Sep 19th, 2019)
 

data/Gemfile

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 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

@@ -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
 
@@ -46,10 +46,12 @@ class PostType < GraphQL::Schema::Object
   field :id, ID, null: false
   field :comments, [String], null: false
   field :isPublished, Boolean, null: true
+  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
   end
 end
 ```
@@ -63,6 +65,16 @@ describe PostType do
   it { is_expected.to have_field(:id).of_type(!types.ID) }
   it { is_expected.to have_field(:comments).of_type("[String!]!") }
   it { is_expected.to have_field(:isPublished).of_type("Boolean") }
+
+  # Check a field is deprecated
+  it { is_expected.to have_field(:published).with_deprecation_reason }
+  it { is_expected.to have_field(:published).with_deprecation_reason('Use isPublished instead') }
+  it { is_expected.not_to have_field(:published).with_deprecation_reason('Wrong reason') }
+  it { is_expected.not_to have_field(:isPublished).with_deprecation_reason }
+
+  # The gem automatically converts field names to CamelCase, so this will
+  # pass even though the field was defined as field :isPublished
+  it { is_expected.to have_field(:is_published).of_type("Boolean") }
 end
 ```
 
@@ -118,6 +130,10 @@ describe PostType do
     end
 
     it { is_expected.not_to accept_argument(:weirdo) }
+
+    # The gem automatically converts argument names to CamelCase, so this will
+    # pass even though the argument was defined as :isPublished
+    it { is_expected.to accept_argument(:is_published).of_type("Boolean") }
   end
 end
 ```
@@ -138,10 +154,45 @@ describe PostType do
 end
 ```
 
+### 6) Using camelize: false on field names
+
+By default the graphql gem camelizes field names. This gem deals with it transparently:
+
+```ruby
+class ObjectMessingWithCamelsAndSnakesType < GraphQL::Schema::Object
+  graphql_name 'ObjectMessingWithCamelsAndSnakes'
+
+  implements GraphQL::Relay::Node.interface
+
+  field :me_gusta_los_camellos, ID, null: false
+
+  # note the camelize: false
+  field :prefiero_serpientes, ID, null: false, camelize: false
+end
+```
+
+The following specs demonstrate the current behavior of the gem regarding fields:
+
+```ruby
+describe ObjectMessingWithCamelsAndSnakesType do
+  subject { described_class }
+
+  # For a field name that was automatically camelized, you can add expectations
+  # against both versions and we handle it transparently:
+  it { is_expected.to have_a_field(:meGustaLosCamellos) }
+  it { is_expected.to have_a_field(:me_gusta_los_camellos) }
+
+  # However, when using camelize: false, you have to use the exact case of the field definition:
+  it { is_expected.to have_a_field(:prefiero_serpientes) }
+  it { is_expected.not_to have_a_field(:prefieroSerpientes) } # Note we're using `not_to`
+end
+```
+
+This behaviour is currently active only on field name matching. PRs are welcome to
+reproduce it to arguments as well.
+
 ## TODO
 
--   Support GraphQL 1.9.x;
--   Check the method used for resolving a field;
 -   New matchers!
 
 ## Contributing

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'
 
@@ -17,16 +19,20 @@ module RSpec
         end
 
         @expected_arg_name = expected_arg_name.to_s
+        @expected_camel_arg_name = GraphQL::Schema::Member::BuildType.camelize(
+          @expected_arg_name
+        )
       end
 
       def matches?(graph_object)
         @graph_object = graph_object
 
         @actual_argument = field_arguments[@expected_arg_name]
+        @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?

data/lib/rspec/graphql_matchers/accept_arguments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_matcher'
 
 module RSpec
@@ -29,7 +31,9 @@ module RSpec
       private
 
       def matches_argument?(arg_name, arg_type)
+        camel_arg_name = GraphQL::Schema::Member::BuildType.camelize(arg_name.to_s)
         actual_arg = actual_field.arguments[arg_name.to_s]
+        actual_arg ||= actual_field.arguments[camel_arg_name]
 
         actual_arg && types_match?(actual_arg.type, arg_type)
       end

data/lib/rspec/graphql_matchers/base_matcher.rb

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

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -5,12 +5,16 @@ require_relative './have_a_field_matchers/of_type'
 require_relative './have_a_field_matchers/with_property'
 require_relative './have_a_field_matchers/with_metadata'
 require_relative './have_a_field_matchers/with_hash_key'
+require_relative './have_a_field_matchers/with_deprecation_reason'
 
 module RSpec
   module GraphqlMatchers
     class HaveAField < BaseMatcher
       def initialize(expected_field_name, fields = :fields)
         @expected_field_name = expected_field_name.to_s
+        @expected_camel_field_name = GraphQL::Schema::Member::BuildType.camelize(
+          @expected_field_name
+        )
         @fields = fields.to_sym
         @expectations = []
       end
@@ -18,12 +22,10 @@ module RSpec
       def matches?(graph_object)
         @graph_object = graph_object
 
-        @actual_field = field_collection[@expected_field_name]
-        @actual_field = @actual_field.to_graphql if @actual_field.respond_to?(:to_graphql)
-        return false if @actual_field.nil?
+        return false if actual_field.nil?
 
         @results = @expectations.reject do |matcher|
-          matcher.matches?(@actual_field)
+          matcher.matches?(actual_field)
         end
 
         @results.empty?
@@ -53,11 +55,16 @@ module RSpec
         self
       end
 
+      def with_deprecation_reason(expected_reason = nil)
+        @expectations << HaveAFieldMatchers::WithDeprecationReason.new(expected_reason)
+        self
+      end
+
       def failure_message
         base_msg = "expected #{member_name(@graph_object)} " \
           "to define field `#{@expected_field_name}`" \
 
-        return "#{base_msg} #{failure_messages.join(', ')}" if @actual_field
+        return "#{base_msg} #{failure_messages.join(', ')}" if actual_field
 
         "#{base_msg} but no field was found with that name"
       end
@@ -68,6 +75,15 @@ module RSpec
 
       private
 
+      def actual_field
+        @actual_field ||= begin
+          field = field_collection[@expected_field_name]
+          field ||= field_collection[@expected_camel_field_name]
+
+          field.respond_to?(:to_graphql) ? field.to_graphql : field
+        end
+      end
+
       def descriptions
         @results.map(&:description)
       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_deprecation_reason.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class WithDeprecationReason
+        def initialize(expected_reason)
+          @expected_reason = expected_reason
+        end
+
+        def matches?(actual_field)
+          @actual_reason = actual_field.deprecation_reason
+
+          if @expected_reason.nil?
+            !actual_field.deprecation_reason.nil?
+          else
+            actual_field.deprecation_reason == @expected_reason
+          end
+        end
+
+        def failure_message
+          message = "#{description}, but it was "
+          message + (@actual_reason.nil? ? 'not deprecated' : "`#{@actual_reason}`")
+        end
+
+        def description
+          if @expected_reason.nil?
+            'with a deprecation reason'
+          else
+            "with deprecation reason `#{@expected_reason}`"
+          end
+        end
+      end
+    end
+  end
+end

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

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.1'
+    VERSION = '1.3.1'.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_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rubocop', '0.71'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'graphql', '>= 1.8', '< 2.0'
+  spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 2.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.1'
+  version: 1.3.1
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -31,47 +31,47 @@ dependencies:
       - !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: '1.12'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        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,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !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
@@ -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
@@ -114,6 +128,7 @@ files:
 - lib/rspec/graphql_matchers/be_of_type.rb
 - lib/rspec/graphql_matchers/have_a_field.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/of_type.rb
+- lib/rspec/graphql_matchers/have_a_field_matchers/with_deprecation_reason.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_hash_key.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_metadata.rb
 - lib/rspec/graphql_matchers/have_a_field_matchers/with_property.rb
@@ -141,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.

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