rspec-graphql_matchers 0.6 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb768f28fb26de27d50fa7f3cc904e59538e0f90
-  data.tar.gz: d1e7f770c4db3ee7dedb58635bf37be01fd50a5a
+  metadata.gz: 2d5a665edd8997d234fa2d6d029c7ede2e6f5686
+  data.tar.gz: 8c558b4b4438bcd32d5dfb4b969f10c7a775fdb9
 SHA512:
-  metadata.gz: b97f59f215849f232d468f982ce25395c80a24242a16a28f9efc9de451b43228dd375aa098a72e64eb97d65c3c6480576ed2dccce8fdd3ff23c644fd8aec3a3e
-  data.tar.gz: 12082a0895c45baae469d80a86832d5d17fa75750e3a8150d816346b7b52d85921f541a58ee564f12ae3b5f92cbda7b3da7c0db9e9c89b78a64b8ce11f7ae52b
+  metadata.gz: 36298dc58bb067d78d0997e5ca7537f09eddfa00931aeec6be867cde92b581e13f83c062417c7b052dd280df4a0a93c30b117b1113a99ee290b27bb800ebb5e7
+  data.tar.gz: 4338619fb13dec26dc567f50cc4bc6fbd826b27d524d61e50be69393b087b152dfca14b728041de0883390dbb8e7384f8f376f8618db86460203cbe8d2cbb702

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
 Style/Documentation:
   Enabled: false
 
@@ -26,3 +30,11 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/rspec/*.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/rspec/*.rb

data/CHANGELOG.md

@@ -8,6 +8,16 @@
 
 ### Bug 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).
+
+### Improvements
+
+  - Default Raketask runs rubocop specs as well (Thanks to @marcgreenstock).
+
 ## 0.6.0 (July 25, 2017)
 
 ### New features

data/README.md

@@ -12,7 +12,7 @@ gem 'rspec-graphql_matchers'
 
 The matchers currently supported are:
    - `expect(a_graphql_object).to have_a_field(field_name).that_returns(valid_type)`
-   - `expect(a_graphql_object).to interface(interface_name, ...)`
+   - `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)`
@@ -24,6 +24,11 @@ Where a valid type for the expectation is either:
    - 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:
+
+  - `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
 
 Given a `GraphQL::ObjectType` defined as
@@ -36,9 +41,15 @@ PostType = GraphQL::ObjectType.define do
 
   interfaces [GraphQL::Relay::Node.interface]
 
-  field :id, !types.ID
+  field :id, !types.ID,
+             property: :post_id
+
+  field :comments,
+        !types[types.String],
+        hash_key: :post_comments
 
-  field :comments, !types[types.String]
+  field :isPublished,
+        admin_only: true
 
   field :subposts, PostType do
     type !PostType
@@ -109,7 +120,17 @@ describe PostType do
 end
 ```
 
-### 3) Test the arguments accepted by a field with `accept_arguments` matcher:
+### 3) Test a specific field with `with_property`, `with_hash_key` and `with_metadata`
+
+```ruby
+describe PostType do
+  it { is_expected.to have_a_field(: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_arguments` matcher:
 
 ```ruby
 describe PostType do
@@ -130,11 +151,17 @@ describe PostType do
 end
 ```
 
-### 4) Test an object's interface implementations:
+The spec will only pass if all attributes/types specified in the hash are
+defined on the field.
+
+For better fluency, `accept_arguments` is also available in singular form, as
+`accept_argument`.
+
+### 5) Test an object's interface implementations:
 
 ```ruby
 describe PostType do
-  it 'interfaces Node' do
+  it 'implements interface Node' do
     expect(subject).to implement('Node')
   end
 
@@ -144,12 +171,6 @@ describe PostType do
 end
 ```
 
-The spec will only pass if all attributes/types specified in the hash are
-defined on the field.
-
-For better fluency, `accept_arguments` is also available in singular form, as
-`accept_argument`.
-
 ## TODO
 
   - New matchers!

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: %i[spec rubocop]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "rspec/graphql_matchers"
+require 'bundler/setup'
+require 'rspec/graphql_matchers'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "rspec/graphql_matchers"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -3,60 +3,99 @@ require_relative 'base_matcher'
 module RSpec
   module GraphqlMatchers
     class HaveAField < BaseMatcher
+      DESCRIPTIONS = {
+        type: 'of type `%s`',
+        property: 'reading from the `%s` property',
+        hash_key: 'reading from the `%s` hash_key',
+        metadata: 'with metadata `%s`'
+      }.freeze
+
       def initialize(expected_field_name, fields = :fields)
         @expected_field_name = expected_field_name.to_s
-        @expected_field_type = @graph_object = nil
         @fields = fields.to_sym
+        @expectations = []
+        @descriptions = []
       end
 
       def matches?(graph_object)
         @graph_object = graph_object
 
         @actual_field = field_collection[@expected_field_name]
-        valid_field? && types_match?(@actual_field.type, @expected_field_type)
+        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?
       end
 
       def that_returns(expected_field_type)
-        @expected_field_type = expected_field_type
-
+        @expectations << [:type, 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]
+        self
+      end
+
+      def with_hash_key(expected_hash_key)
+        @expectations << [:hash_key, expected_hash_key]
+        self
+      end
+
+      def with_metadata(expected_metadata)
+        @expectations << [:metadata, expected_metadata]
+        self
+      end
+
       def failure_message
         "expected #{describe_obj(@graph_object)} to " \
           "#{description}, #{explanation}."
       end
 
       def description
-        "define field `#{@expected_field_name}`" + of_type_description
+        ["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
-
-        "but the field type was `#{@actual_field.type}`"
+        @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 valid_field?
-        unless @expected_field_type.nil? || @actual_field.respond_to?(:type)
-          error_msg = "The `#{@expected_field_name}` field defined by the GraphQL " \
-          'object does\'t seem valid as it does not respond to #type. ' \
-          "\n\n\tThe field found was #{@actual_field.inspect}. "
-          puts error_msg
-          raise error_msg
+      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
-
-        @actual_field
       end
 
-      def of_type_description
-        return '' unless @expected_field_type
-
-        " of type `#{@expected_field_type}`"
+      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)

data/lib/rspec/graphql_matchers/matchers.rb

@@ -20,14 +20,10 @@ module RSpec
       RSpec::GraphqlMatchers::HaveAField.new(field_name)
     end
     alias have_field have_a_field
-
-    # rubocop:disable Style/PredicateName
     def have_an_input_field(field_name)
       RSpec::GraphqlMatchers::HaveAField.new(field_name, :input_fields)
     end
     alias have_input_field have_an_input_field
-
-    # rubocop:disable Style/PredicateName
     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.6'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

data/rspec-graphql_matchers.gemspec

@@ -1,26 +1,31 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec/graphql_matchers/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'rspec-graphql_matchers'
-  spec.version       = Rspec::GraphqlMatchers::VERSION
-  spec.authors       = ['Samuel Brandão']
-  spec.email         = ['gb.samuel@gmail.com']
+  spec.name = 'rspec-graphql_matchers'
+  spec.version = Rspec::GraphqlMatchers::VERSION
+  spec.authors = ['Samuel Brandão']
+  spec.email = ['gb.samuel@gmail.com']
 
-  spec.summary       = 'Collection of rspec matchers to test your graphQL api schema.'
-  spec.homepage      = 'https://github.com/khamusa/rspec-graphql_matchers'
-  spec.license       = 'MIT'
+  spec.summary = 'Collection of rspec matchers to test your graphQL api schema.'
+  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.'
+  # raise 'RubyGems 2.0 or newer is required to protect against public gem ' \
+  #       'pushes.'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files =
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  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', '>= 0.9', '< 2'
   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.6'
+  version: 0.7.1
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql