rspec-graphql_matchers 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64ee8b20fc5bbe24c5526a14923eba402e023d52
+  data.tar.gz: 2203f40b9379eecc78296e0637bb8033e91daa5b
+SHA512:
+  metadata.gz: 85b11832795d76ca55a19c7fe62c9cc60fa5560781031dfac192ee16779624366da10e15d1178d3e7fda5c6779804ad8aa40749864236f9c4a157697e6e54a4d
+  data.tar.gz: 4770e6cbeabe74e48b36ed621fbe494ae37195ae5e0cc766a639a13b660173ab44ae5261cda8d9fd45578cfb29531b8a36caed301bea118cc3bfbfbccf89822a

data/.codeclimate.yml

@@ -0,0 +1,31 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/
+- rspec-graphql_matchers.gemspec
+- bin/
+- Rakefile

data/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig help us maintain consistent coding style between different editors.
+#
+# EditorConfig
+# http://editorconfig.org
+#
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/SpaceBeforeFirstArg:
+  Include:
+    - db/migrate/*.rb
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 80
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gb.samuel@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-graphql_matchers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Samuel Brandão
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# Rspec::GraphqlMatchers
+
+Convenient rspec matchers for testing your (GraphQL)[https://github.com/rmosolgo/graphql-ruby] API/Schema.
+
+## Installation
+
+```
+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)
+
+Where a type identifier is either:
+   - A GraphQL type object (ex: `types.String`, `!types.Int`, `types[types.Int]`)
+   - A String representation of a type: `"String!"`, `"Int!"`, `"[String]!"`
+
+## Examples
+
+Given a GraphQL type defined as such
+
+```ruby
+
+PostType = GraphQL::ObjectType.define do
+  name "Post"
+  description "A blog post"
+
+  field :id, !types.ID
+
+  field :comments, !types[types.String]
+
+  field :subposts, PostType do
+    type !PostType
+
+    argument :filter, types.String
+    argument :id, types.ID
+  end
+end
+```
+
+### 1) Test the field types 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
+
+  describe 'subposts' do
+    subject { PostType.fields['subposts'] }
+
+    # You can use your type object directly when building expectations
+    it 'has type PostType' do
+      expect(subject).to be_of_type(!PostType)
+    end
+
+    # Or as usual, a literal String
+    it { is_expected.to be_of_type('Post!') }
+  end
+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 the type name as a String.
+
+You can also use the built-in GraphQL scalar types:
+
+
+```ruby
+# ensure you have the GraphQL type definer available in your tests
+types = GraphQL::Define::TypeDefiner.instance
+
+describe PostType do
+  describe 'comments' do
+    subject { PostType.fields['comments'] }
+    it { is_expected.to be_of_type(!types[types.String]) }
+    it { is_expected.to be_of_type('[String]!') }
+  end
+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:
+
+Testing arguments use the `accept_arguments` matcher passing a hash where
+keys represent the attribute name and values respresent the attribute type.
+
+```ruby
+describe PostType do
+  describe 'subposts' do
+    subject { PostType.fields['subposts'] }
+
+    let(:a_whole_bunch_of_args) do
+      { filter: 'String', id: types.Int, pippo: 'Float', posts: PostType }
+    end
+
+    it 'accepts a filter and an id argument, of types String and ID' do
+      expect(subject).to accept_arguments(filter: types.String, id: types.ID)
+    end
+
+    # You can also test if a field does not accept args. Not quite useful :D.
+    it { is_expected.not_to accept_arguments(a_whole_bunch_of_args) }
+  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
+`accept_argument`.
+
+## Contributing
+
+  - 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,
+    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
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/graphql_matchers/accept_arguments.rb

@@ -0,0 +1,45 @@
+module RSpec
+  module GraphqlMatchers
+    class AcceptArguments
+      attr_reader :actual_field, :expected_args
+
+      def initialize(expected_args)
+        @expected_args = expected_args
+      end
+
+      def matches?(actual_field)
+        @actual_field = actual_field
+
+        @expected_args.all? do |arg_name, arg_type|
+          matches_argument?(arg_name, arg_type)
+        end
+      end
+
+      def failure_message
+        "expected field '#{field_name(actual_field)}' to accept arguments "\
+        "#{describe_arguments(expected_args)}"
+      end
+
+      def description
+        "accept arguments #{describe_arguments(expected_args)}"
+      end
+
+      private
+
+      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
+      end
+
+      def describe_arguments(what_args)
+        what_args.sort.map do |arg_name, arg_type|
+          "#{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/be_of_type.rb

@@ -0,0 +1,31 @@
+module RSpec
+  module GraphqlMatchers
+    class BeOfType
+      attr_reader :sample, :expected
+
+      def initialize(expected)
+        @expected = expected
+      end
+
+      def matches?(actual_sample)
+        @sample = actual_sample
+        sample.type.to_s == @expected.to_s
+      end
+
+      def failure_message
+        "expected field '#{field_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/matchers.rb

@@ -0,0 +1,17 @@
+require 'rspec/matchers'
+require 'rspec/graphql_matchers/be_of_type'
+require 'rspec/graphql_matchers/accept_arguments'
+
+module RSpec
+  module Matchers
+    def be_of_type(expected)
+      RSpec::GraphqlMatchers::BeOfType.new(expected)
+    end
+
+    def accept_arguments(expected_args)
+      RSpec::GraphqlMatchers::AcceptArguments.new(expected_args)
+    end
+
+    alias accept_argument accept_arguments
+  end
+end

data/lib/rspec/graphql_matchers/types_helper.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module GraphqlMatchers
+    module TypesHelper
+      def types
+        GraphQL::Define::TypeDefiner.instance
+      end
+    end
+  end
+end

data/lib/rspec/graphql_matchers/version.rb

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

data/lib/rspec/graphql_matchers.rb

@@ -0,0 +1,3 @@
+require 'rspec/graphql_matchers/version'
+require 'rspec/graphql_matchers/matchers'
+require 'rspec/graphql_matchers/types_helper'

data/rspec-graphql_matchers.gemspec

@@ -0,0 +1,28 @@
+# 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.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.'
+
+  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', '< 1'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: rspec-graphql_matchers
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Samuel Brandão
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gb.samuel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/graphql_matchers.rb
+- lib/rspec/graphql_matchers/accept_arguments.rb
+- lib/rspec/graphql_matchers/be_of_type.rb
+- lib/rspec/graphql_matchers/matchers.rb
+- lib/rspec/graphql_matchers/types_helper.rb
+- lib/rspec/graphql_matchers/version.rb
+- rspec-graphql_matchers.gemspec
+homepage: https://github.com/khamusa/rspec-graphql_matchers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Collection of rspec matchers to test your graphQL api schema.
+test_files: []
+has_rdoc: