rspec-graphql_matchers 0.7.1 → 1.0.0.pre.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d5a665edd8997d234fa2d6d029c7ede2e6f5686
-  data.tar.gz: 8c558b4b4438bcd32d5dfb4b969f10c7a775fdb9
+SHA256:
+  metadata.gz: 2c995f57264270239040010ba138b480e7280b05e1ca75b54dbc4a03426ba42c
+  data.tar.gz: fcbc1410d22f83530270cd24db7cbe81541754a0b8cd58d27265dd7b248cdf3c
 SHA512:
-  metadata.gz: 36298dc58bb067d78d0997e5ca7537f09eddfa00931aeec6be867cde92b581e13f83c062417c7b052dd280df4a0a93c30b117b1113a99ee290b27bb800ebb5e7
-  data.tar.gz: 4338619fb13dec26dc567f50cc4bc6fbd826b27d524d61e50be69393b087b152dfca14b728041de0883390dbb8e7384f8f376f8618db86460203cbe8d2cbb702
+  metadata.gz: 150c4f842ffef148a7063803d09d4c5433f7ff63637e70fb9cafc2ddb3e6d480ccc1662af7f30aaf241791ae6c53e03e24698b8bd4055cf5dc2d47bd273ed10b
+  data.tar.gz: 2779881b25f48f04c8f276c4ce5ea6aee3e376f6058e83ecfa54b9c5e04c7e24c31127cb66c07f5a861b1da2af2fe8e12517fb369d52cb3edeb810e09d924552

data/.rubocop.yml

@@ -26,7 +26,7 @@ Style/Lambda:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 80
+  Max: 90
 
 Metrics/MethodLength:
   Max: 15

data/.travis.yml

@@ -3,3 +3,4 @@ language: ruby
 rvm:
   - 2.3.1
 before_install: gem install bundler -v 1.12.3
+script: bundle exec rake

data/CHANGELOG.md

@@ -8,37 +8,57 @@
 
 ### Bug fixes
 
+## 1.0 (June, 2019)
+
+### Breaking changes
+
+-   Support to property and hash_key matchers will be dropped on upcoming releases.
+
+### Deprecations
+
+-   `.with_metadata` and `.with_property` matchers for fields will be removed on the next release.
+
+### New features
+
+-   Add support for Class-based type definition api (adds support for graphql-ruby v1.8.x). Please note that `.with_metadata` and `.with_property` support has been kept but will only work on fields defined using the legacy api.
+
+### Bug fixes
+
+## 0.7.1 (July 27, 2017)
+
+Changelog fixes.
+
 ## 0.7.0 (July 27, 2017)
 
 ### New features
 
-  - (#9, #8) New chainable matchers `with_property`, `with_hash_key` and `with_metadata` (Thanks to @marcgreenstock).
+-   (#3, #8) New chainable matchers `with_property`, `with_hash_key` and `with_metadata` (Thanks to @marcgreenstock).
 
 ### Improvements
 
-  - Default Raketask runs rubocop specs as well (Thanks to @marcgreenstock).
+-   Default Raketask runs rubocop specs as well (Thanks to @marcgreenstock).
 
 ## 0.6.0 (July 25, 2017)
 
 ### New features
 
-  - (PR #6) New matchers for interfaces: `expect(...).to implement(interface)` (Thanks to @marcgreenstock).
+-   (PR #6) New matchers for interfaces: `expect(...).to implement(interface)` (Thanks to @marcgreenstock).
 
 ## 0.5.0 (May 10, 2017)
 
 ### New features
 
-  - (PR #4) New matchers for mutations: `have_an_input_field` and `have_a_return_field` (Thanks to @aaronklaassen).
+-   (PR #4) New matchers for mutations: `have_an_input_field` and `have_a_return_field` (Thanks to @aaronklaassen).
 
 ## 0.4.0 (Feb, 2017)
 
 ### New features
 
- - Improvements on error messages of have_a_field(...).of_type(...)
+-   Improvements on error messages of have_a_field(...).of_type(...)
 
 ### Bug fixes
 
-  - Fixed a bug preventing proper type checking when using matchers in the form have_a_field(fname).of_type(types.X). The bug would not happen when providing the type expectation as a string, only when using the GraphQL constants.
+-   Fixed a bug preventing proper type checking when using matchers in the form have_a_field(fname).of_type(types.X). The bug would not happen when providing the type expectation as a string, only when using the GraphQL constants.
 
 ## 0.3.0 (Sep 16, 2016)
 
@@ -48,7 +68,7 @@
 
 ### New features
 
-- New matcher have_field(field_name).of_type(type) for testing types and their fields
+-   New matcher have_field(field_name).of_type(type) for testing types and their fields
 
 ### Bug fixes
 
@@ -60,7 +80,7 @@
 
 ### New features
 
-- New matcher be_of_type for testing fields
-- New matcher accept_arguments for testing fields
+-   New matcher be_of_type for testing fields
+-   New matcher accept_arguments for testing fields
 
 ### Bug fixes

data/README.md

@@ -1,3 +1,5 @@
+![Build Status](https://travis-ci.org/khamusa/rspec-graphql_matchers.svg?branch=master)
+
 # Rspec::GraphqlMatchers
 
 Convenient rspec matchers for testing your [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) API/Schema.
@@ -11,23 +13,25 @@ gem 'rspec-graphql_matchers'
 ## Usage
 
 The matchers currently supported are:
-   - `expect(a_graphql_object).to have_a_field(field_name).that_returns(valid_type)`
-   - `expect(a_graphql_object).to implement(interface_name, ...)`
-   - `expect(a_mutation_type).to have_a_return_field(field_name).returning(valid_type)`
-   - `expect(a_mutation_type).to have_an_input_field(field_name).of_type(valid_type)`
-   - `expect(a_field).to be_of_type(valid_type)`
-   - `expect(an_input).to accept_arguments(hash_of_arg_names_and_valid_types)`
-   - `expect(an_input).to accept_arguments(hash_of_arg_names_and_valid_types)`
+
+-   `expect(a_graphql_object).to have_a_field(field_name).that_returns(valid_type)`
+-   `expect(a_graphql_object).to implement(interface_name, ...)`
+-   `expect(a_mutation_type).to have_a_return_field(field_name).returning(valid_type)`
+-   `expect(a_mutation_type).to have_an_input_field(field_name).of_type(valid_type)`
+-   `expect(a_field).to be_of_type(valid_type)`
+-   `expect(an_input).to accept_arguments(hash_of_arg_names_and_valid_types)`
+-   `expect(an_input).to accept_arguments(hash_of_arg_names_and_valid_types)`
 
 Where a valid type for the expectation is either:
-   - A `GraphQL::ObjectType` object (ex: `types.String`, `!types.Int`, `types[types.Int]`, or your own)
-   - 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/).
 
-Testing `:property`, `:hash_key` and *metadata* is also possible by chaining `.with_property`, `.with_hash_key` and `.with_metadata`. For example:
+-   A reference to the actual type you expect;
+-   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/).
 
-  - `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)`
+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)`
 
 ## Examples
 
@@ -73,6 +77,7 @@ describe PostType do
   it { is_expected.to have_a_field(:id).returning("ID!") }
 end
 ```
+
 ### 2) Test a specific field type with `be_of_type` matcher:
 
 ```ruby
@@ -101,9 +106,9 @@ end
 Keep in mind that when using strings as type expectation you have to use the
 type name (`Post`) and not the constant name (`PostType`).
 
-Using your type objects directly has the advantage that if you
-decide to rename the type your specs won't break, as they would had you
-hardcoded it as a String.
+Using your type objects directly is riskier than the string representation, since
+renaming the graphql name of an object is potentially a breaking change that
+wouldn't get caught by your test suite.
 
 You can also use the built-in [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) scalar types:
 
@@ -173,14 +178,14 @@ end
 
 ## TODO
 
-  - New matchers!
+-   New matchers!
 
 ## Contributing
 
-  - Send Bug reports, suggestions or any general
+-   Send Bug reports, suggestions or any general
     question through the [Issue tracker](https://github.com/khamusa/rspec-graphql_matchers/issues).
     Think of another matcher that could be useful? This is the place to ask, or...
-  - Pull requests are welcome through the usual procedure: fork the project,
+-   Pull requests are welcome through the usual procedure: fork the project,
     commit your changes and open the [PR](https://github.com/khamusa/rspec-graphql_matchers/pulls).
 
 This project is intended to be a safe, welcoming space for collaboration, and

data/lib/rspec/graphql_matchers/accept_arguments.rb

@@ -1,6 +1,8 @@
+require_relative 'base_matcher'
+require 'pry'
 module RSpec
   module GraphqlMatchers
-    class AcceptArguments
+    class AcceptArguments < BaseMatcher
       attr_reader :actual_field, :expected_args
 
       def initialize(expected_args)
@@ -16,7 +18,7 @@ module RSpec
       end
 
       def failure_message
-        "expected field '#{field_name(actual_field)}' to accept arguments "\
+        "expected field '#{member_name(actual_field)}' to accept arguments "\
         "#{describe_arguments(expected_args)}"
       end
 
@@ -28,7 +30,8 @@ module RSpec
 
       def matches_argument?(arg_name, arg_type)
         actual_arg = actual_field.arguments[arg_name.to_s]
-        actual_arg && actual_arg.type.to_s == arg_type.to_s
+
+        actual_arg && types_match?(actual_arg.type, arg_type)
       end
 
       def describe_arguments(what_args)
@@ -36,10 +39,6 @@ module RSpec
           "#{arg_name}(#{arg_type})"
         end.join(', ')
       end
-
-      def field_name(field)
-        field.respond_to?(:name) && field.name || field.inspect
-      end
     end
   end
 end

data/lib/rspec/graphql_matchers/base_matcher.rb

@@ -3,7 +3,16 @@ module RSpec
     class BaseMatcher
       private
 
+      def member_name(member)
+        member.respond_to?(:graphql_name) && member.graphql_name ||
+          member.respond_to?(:name) && member.name ||
+          member.inspect
+      end
+
       def types_match?(actual_type, expected_type)
+        actual_type = actual_type.to_graphql if actual_type.respond_to?(:to_graphql)
+        expected_type = expected_type.to_graphql if expected_type.respond_to?(:to_graphql)
+
         expected_type.nil? || expected_type.to_s == actual_type.to_s
       end
     end

data/lib/rspec/graphql_matchers/be_of_type.rb

@@ -1,6 +1,8 @@
+require_relative 'base_matcher'
+
 module RSpec
   module GraphqlMatchers
-    class BeOfType
+    class BeOfType < BaseMatcher
       attr_reader :sample, :expected
 
       def initialize(expected)
@@ -9,23 +11,17 @@ module RSpec
 
       def matches?(actual_sample)
         @sample = actual_sample
-        sample.type.to_s == @expected.to_s
+        sample.respond_to?(:type) && sample.type.to_s == @expected.to_s
       end
 
       def failure_message
-        "expected field '#{field_name(sample)}' to be of type '#{expected}', " \
+        "expected field '#{member_name(sample)}' to be of type '#{expected}', " \
         "but it was '#{sample.type}'"
       end
 
       def description
         "be of type '#{expected}'"
       end
-
-      private
-
-      def field_name(field)
-        field.respond_to?(:name) && field.name || field.inspect
-      end
     end
   end
 end

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -1,4 +1,8 @@
 require_relative 'base_matcher'
+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'
 
 module RSpec
   module GraphqlMatchers
@@ -23,83 +27,54 @@ module RSpec
         @actual_field = field_collection[@expected_field_name]
         return false if @actual_field.nil?
 
-        @results = @expectations.map do |expectaiton|
-          name, expected_value = expectaiton
-          [name, expectation_matches?(name, expected_value)]
-        end.to_h
-        @results.values.all?
+        @results = @expectations.select do |matcher|
+          !matcher.matches?(@actual_field)
+        end
+
+        @results.empty?
       end
 
       def that_returns(expected_field_type)
-        @expectations << [:type, expected_field_type]
+        @expectations << HaveAFieldMatchers::OfType.new(expected_field_type)
         self
       end
+
       alias returning that_returns
       alias of_type that_returns
 
       def with_property(expected_property_name)
-        @expectations << [:property, expected_property_name]
+        @expectations << HaveAFieldMatchers::WithProperty.new(expected_property_name)
         self
       end
 
       def with_hash_key(expected_hash_key)
-        @expectations << [:hash_key, expected_hash_key]
+        @expectations << HaveAFieldMatchers::WithHashKey.new(expected_hash_key)
+
         self
       end
 
       def with_metadata(expected_metadata)
-        @expectations << [:metadata, expected_metadata]
+        @expectations << HaveAFieldMatchers::WithMetadata.new(expected_metadata)
         self
       end
 
       def failure_message
-        "expected #{describe_obj(@graph_object)} to " \
-          "#{description}, #{explanation}."
+        base_msg = "expected #{member_name(@graph_object)} " \
+          "to define field `#{@expected_field_name}`" \
+
+        return "#{base_msg} #{descriptions.join(', ')}" if @actual_field
+
+        "#{base_msg} but no field was found with that name"
       end
 
       def description
-        ["define field `#{@expected_field_name}`"]
-          .concat(descriptions).join(', ')
+        ["define field `#{@expected_field_name}`"].concat(descriptions).join(', ')
       end
 
       private
 
       def descriptions
-        @expectations.map do |expectation|
-          name, expected_value = expectation
-          format(DESCRIPTIONS[name], expected_value)
-        end
-      end
-
-      def explanation
-        return 'but no field was found with that name' unless @actual_field
-        @results.each do |result|
-          name, match = result
-          next if match
-          return format('but the %s was `%s`', name, @actual_field.send(name))
-        end
-      end
-
-      def expectation_matches?(name, expected_value)
-        ensure_method_exists!(name)
-        if expected_value.is_a?(Hash)
-          @actual_field.send(name) == expected_value
-        else
-          @actual_field.send(name).to_s == expected_value.to_s
-        end
-      end
-
-      def ensure_method_exists!(method_name)
-        return if @actual_field.respond_to?(method_name)
-        raise(
-          "The `#{@expected_field_name}` field defined by the GraphQL object " \
-          "does\'t seem valid as it does not respond to ##{method_name}. " \
-          "\n\n\tThe field found was #{@actual_field.inspect}. "
-        )
-      end
-
-      def describe_obj(field)
-        field.respond_to?(:name) && field.name || field.inspect
+        @results.map(&:description)
       end
 
       def field_collection

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

@@ -0,0 +1,11 @@
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class OfType < RSpec::GraphqlMatchers::BeOfType
+        def description
+          "of type `#{expected}`"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class WithHashKey
+        def initialize(expected_hash_key)
+          @expected_hash_key = expected_hash_key
+        end
+
+        def description
+          "with hash key `#{@expected_hash_key}`"
+        end
+
+        def matches?(actual_field)
+          get_hash_key(actual_field) == @expected_hash_key.to_sym
+        end
+
+        private
+
+        def get_hash_key(actual_field)
+          if actual_field.respond_to?(:hash_key)
+            return actual_field.hash_key.to_sym
+          end
+
+          # Class-based api
+          actual_field.method_sym
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class WithMetadata
+        def initialize(expected_metadata)
+          @expected_metadata = expected_metadata
+        end
+
+        def description
+          "with metadata `#{@expected_metadata}`"
+        end
+
+        def matches?(actual_field)
+          actual_field.metadata == @expected_metadata
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module RSpec
+  module GraphqlMatchers
+    module HaveAFieldMatchers
+      class WithProperty
+        def initialize(expected_property_name)
+          @expected_property_name = expected_property_name
+        end
+
+        def description
+          "resolving with property `#{@expected_property_name}`"
+        end
+
+        def matches?(actual_field)
+          actual_field.property.to_sym == @expected_property_name.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/implement.rb

@@ -10,9 +10,7 @@ module RSpec
       def matches?(graph_object)
         @graph_object = graph_object
         @actual = actual
-        @expected.each do |name|
-          return false unless @actual.include?(name)
-        end
+        @expected.all? { |name| @actual.include?(name) }
       end
 
       def failure_message
@@ -35,12 +33,20 @@ module RSpec
 
       def actual
         if @graph_object.respond_to?(:interfaces)
-          @graph_object.interfaces.map(&:to_s)
+          @graph_object.interfaces.map do |interface|
+            interface_name(interface)
+          end
         else
           raise "Invalid object #{@graph_object} provided to #{matcher_name} " \
             'matcher. It does not seem to be a valid GraphQL object type.'
         end
       end
+
+      def interface_name(interface)
+        return interface.graphql_name if interface.respond_to?(:graphql_name)
+
+        interface.to_s
+      end
     end
   end
 end

data/lib/rspec/graphql_matchers/matchers.rb

@@ -20,10 +20,12 @@ module RSpec
       RSpec::GraphqlMatchers::HaveAField.new(field_name)
     end
     alias have_field have_a_field
+
     def have_an_input_field(field_name)
       RSpec::GraphqlMatchers::HaveAField.new(field_name, :input_fields)
     end
     alias have_input_field have_an_input_field
+
     def have_a_return_field(field_name)
       RSpec::GraphqlMatchers::HaveAField.new(field_name, :return_fields)
     end

data/lib/rspec/graphql_matchers/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module GraphqlMatchers
-    VERSION = '0.7.1'.freeze
+    VERSION = '1.0.0-0.1'.freeze
   end
 end

data/rspec-graphql_matchers.gemspec

@@ -25,7 +25,7 @@ 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', '>= 0.9', '< 2'
+  spec.add_runtime_dependency 'graphql', '>= 1.8', '< 1.9'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rubocop', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0.pre.0.1
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,10 @@ files:
 - lib/rspec/graphql_matchers/base_matcher.rb
 - 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_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
 - lib/rspec/graphql_matchers/implement.rb
 - lib/rspec/graphql_matchers/matchers.rb
 - lib/rspec/graphql_matchers/types_helper.rb
@@ -132,12 +136,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: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.