rspec-graphql_matchers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64ee8b20fc5bbe24c5526a14923eba402e023d52
-  data.tar.gz: 2203f40b9379eecc78296e0637bb8033e91daa5b
+  metadata.gz: eeaf0169ad7a9777dcd7391a7bc3572183d26156
+  data.tar.gz: e0f63135573cc773951fb2ffcae9870257cee9f7
 SHA512:
-  metadata.gz: 85b11832795d76ca55a19c7fe62c9cc60fa5560781031dfac192ee16779624366da10e15d1178d3e7fda5c6779804ad8aa40749864236f9c4a157697e6e54a4d
-  data.tar.gz: 4770e6cbeabe74e48b36ed621fbe494ae37195ae5e0cc766a639a13b660173ab44ae5261cda8d9fd45578cfb29531b8a36caed301bea118cc3bfbfbccf89822a
+  metadata.gz: 99166b1bad15d1a1b8cf11dfbc5a7f73a52597b34dbc4fc09111761f848974bd664ca95aaf659c9020d0fc22d0a7833fb45f8bbd9a3df07016e1e28b60b3bb1f
+  data.tar.gz: 18a35b6bb8e5c8f56ca7a2b3b8f75cf95350a29b805589b665fa38d2514b6e378964a71ed56ba9e8a59327aef622afa7c0393f5a8b8b79bec1afaa6def0ecba7

data/.codeclimate.yml

@@ -1,7 +1,5 @@
 ---
 engines:
-  bundler-audit:
-    enabled: true
   duplication:
     enabled: true
     config:
@@ -16,7 +14,6 @@ engines:
     enabled: true
 ratings:
   paths:
-  - Gemfile.lock
   - "**.inc"
   - "**.js"
   - "**.jsx"
@@ -25,6 +22,7 @@ ratings:
   - "**.py"
   - "**.rb"
 exclude_paths:
+- Gemfile.lock
 - spec/
 - rspec-graphql_matchers.gemspec
 - bin/

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+### Breaking changes
+
+### Deprecations
+
+### New features
+
+### Bug fixes
+
+## 0.3.0 (Sep 16, 2016)
+
+### Breaking changes
+
+### Deprecations
+
+### New features
+
+- New matcher have_field(field_name).of_type(type) for testing types and their fields
+
+### Bug fixes
+
+## 0.2.0 Initial public release
+
+### Breaking changes
+
+### Deprecations
+
+### New features
+
+- New matcher be_of_type for testing fields
+- New matcher accept_arguments for testing fields
+
+### Bug fixes

data/README.md

@@ -1,6 +1,6 @@
 # Rspec::GraphqlMatchers
 
-Convenient rspec matchers for testing your (GraphQL)[https://github.com/rmosolgo/graphql-ruby] API/Schema.
+Convenient rspec matchers for testing your [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) API/Schema.
 
 ## Installation
 
@@ -10,17 +10,19 @@ gem 'rspec-graphql_matchers'
 
 ## Usage
 
-The two matchers currently supported are:
-   - be_of_type(a_graphql_type_identifier)
-   - accept_arguments(hash_of_arg_names_and_type_identifiers)
+The matchers currently supported are:
+   - `expect(graphql_type).to have_a_field(field_name).that_returns(valid_type)`
+   - `expect(graphql_field).to be_of_type(valid_type)`
+   - `expect(graphql_field).to accept_arguments(hash_of_arg_names_and_valid_types)`
 
-Where a type identifier is either:
-   - A GraphQL type object (ex: `types.String`, `!types.Int`, `types[types.Int]`)
+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/).
 
 ## Examples
 
-Given a GraphQL type defined as such
+Given a `GraphQL::ObjectType` defined as
 
 ```ruby
 
@@ -41,17 +43,27 @@ PostType = GraphQL::ObjectType.define do
 end
 ```
 
-### 1) Test the field types with `be_of_type` matcher:
+### 1) Test your type defines the correct fields:
+
+```ruby
+describe PostType do
+  it 'defines a field id of type ID!' do
+    expect(subject).to have_field(:id).that_returns(!types.ID)
+  end
+
+  # Fluent alternatives
+  it { is_expected.to have_field(:id).of_type("ID!") }
+  it { is_expected.to have_a_field(:id).returning("ID!") }
+end
+```
+### 2) Test a specific field type with `be_of_type` matcher:
 
 ```ruby
 describe PostType do
   describe 'id' do
     subject { PostType.fields['id'] }
 
-    # These will match
     it { is_expected.to be_of_type('ID!') }
-
-    # While 'Float!' will not match
     it { is_expected.not_to be_of_type('Float!') }
   end
 
@@ -74,10 +86,9 @@ 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 the type name as a String.
-
-You can also use the built-in GraphQL scalar types:
+hardcoded it as a String.
 
+You can also use the built-in [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) scalar types:
 
 ```ruby
 # ensure you have the GraphQL type definer available in your tests
@@ -94,14 +105,10 @@ end
 
 Having to define `types` everywhere is quite annoying. If you prefer, you can
 just `include RSpec::GraphqlMatchers::TypesHelper` once 
-(for example in your `spec_helper.rb`, but not within a `RSpec.configure` block)
-and the `types` shortcut will be available globally (ouch!) for your tests.
-Use at your own risk.
-
-### 2) Test the arguments accepted by a field with `accept_arguments` matcher:
+(for example in your `spec_helper.rb`)
+and the `types` shortcut will be available within the include context.
 
-Testing arguments use the `accept_arguments` matcher passing a hash where
-keys represent the attribute name and values respresent the attribute type.
+### 3) Test the arguments accepted by a field with `accept_arguments` matcher:
 
 ```ruby
 describe PostType do
@@ -121,13 +128,19 @@ describe PostType do
   end
 end
 ```
-The spec will pass only if all attributes/types specified in the hash are
-defined on the field. Type specification follows the same rules from
-`be_of_type` matcher.
 
-For better fluency, `accept_arguments` is always available in singular form, as
+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
+
+  - Setup CI and integrate w/codeclimate
+  - Setup codeclimate / CI badges
+  - New matchers!
+
 ## Contributing
 
   - Send Bug reports, suggestions or any general

data/lib/rspec/graphql_matchers/have_a_field.rb

@@ -0,0 +1,49 @@
+module RSpec
+  module GraphqlMatchers
+    class HaveAField
+      def initialize(field_name)
+        @field_name = field_name.to_s
+        @field_type = @graph_object = nil
+      end
+
+      def matches?(graph_object)
+        @graph_object = graph_object
+
+        actual_field = @graph_object.fields[@field_name]
+        actual_field && types_match?(@field_type, actual_field.type)
+      end
+
+      def that_returns(field_type)
+        @field_type = field_type
+
+        self
+      end
+      alias returning that_returns
+      alias of_type that_returns
+
+      def failure_message
+        "expected #{describe_obj(@graph_object)} to #{description}"
+      end
+
+      def description
+        "define field `#{@field_name}`" + of_type_description
+      end
+
+      private
+
+      def of_type_description
+        return '' unless @field_type
+
+        " of type `#{@field_type}`"
+      end
+
+      def types_match?(expected_type, actual_type)
+        !expected_type || expected_type.to_s == actual_type.to_s
+      end
+
+      def describe_obj(field)
+        field.respond_to?(:name) && field.name || field.inspect
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/matchers.rb

@@ -1,6 +1,7 @@
 require 'rspec/matchers'
 require 'rspec/graphql_matchers/be_of_type'
 require 'rspec/graphql_matchers/accept_arguments'
+require 'rspec/graphql_matchers/have_a_field'
 
 module RSpec
   module Matchers
@@ -11,7 +12,12 @@ module RSpec
     def accept_arguments(expected_args)
       RSpec::GraphqlMatchers::AcceptArguments.new(expected_args)
     end
-
     alias accept_argument accept_arguments
+
+    # rubocop:disable Style/PredicateName
+    def have_a_field(field_name)
+      RSpec::GraphqlMatchers::HaveAField.new(field_name)
+    end
+    alias have_field have_a_field
   end
 end

data/lib/rspec/graphql_matchers/types_helper.rb

@@ -1,3 +1,5 @@
+require 'graphql'
+
 module RSpec
   module GraphqlMatchers
     module TypesHelper

data/lib/rspec/graphql_matchers/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module GraphqlMatchers
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-graphql_matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Brandão
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -99,6 +99,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -109,6 +110,7 @@ files:
 - lib/rspec/graphql_matchers.rb
 - lib/rspec/graphql_matchers/accept_arguments.rb
 - lib/rspec/graphql_matchers/be_of_type.rb
+- lib/rspec/graphql_matchers/have_a_field.rb
 - lib/rspec/graphql_matchers/matchers.rb
 - lib/rspec/graphql_matchers/types_helper.rb
 - lib/rspec/graphql_matchers/version.rb
@@ -133,9 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Collection of rspec matchers to test your graphQL api schema.
 test_files: []
-has_rdoc: