shoulda-matchers-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1dda9cb6eba5cb1129c6905dbd6c3d34ab2ac4d1482adf5e8500f713e9c92451
+  data.tar.gz: d8220c29706785d25188e044e70b66b75a581bb6a544a843807847b1dbfca99a
+SHA512:
+  metadata.gz: 0f359b8383ef1199057b61452833f765d3a2be457d339aa872a6cfac6083c834d9cffaed1167c29e3bca29af2a259c1689592169d7b215406aade3b803870715
+  data.tar.gz: 9ef6fe5fa26306af6ffd3f80223cda69daf844d1a5e80bb79dde73e08ebd09a959882355df7fc498b99677e3b996c6a64523ab2456264c677fa4978f103cc9b4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shoulda-matchers-graphql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    shoulda-matchers-graphql (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    shoulda-matchers (4.0.1)
+      activesupport (>= 4.2.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shoulda-matchers (~> 4.0.1)
+  shoulda-matchers-graphql!
+  yard
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,85 @@
+# Shoulda::Matchers::Graphql
+
+Shoulda-style matchers for GraphQL. 
+
+Note: not affiliated with [Thoughtbot's `Shoulda::Matchers`](https://github.com/thoughtbot/shoulda-matchers), but heavily inspired by and grateful for.
+
+Another Note: This library works with or without `Shoulda::Matchers` in a project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shoulda-matchers-graphql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoulda-matchers-graphql
+
+## Usage
+
+Configure RSpec:
+
+```ruby
+RSpec.configure do |config|
+  config.include(Shoulda::Matchers::Graphql)
+end
+```
+
+Use the matchers:
+
+```ruby
+class Types::Post < GraphQL::Schema::Object
+  description "This is a Types::Post"
+  field :id, ID, "ID description", null: false
+  field :text, String, null: false
+  field :author, Types::Author, null: false # defined elsewhere
+  field :comments, [Types::Comment], null: true # defined elsewhere
+end
+
+class Types::QueryType < GraphQL::Schema::Object
+  field :post, Types::Post, null: true do
+    argument :id, ID, required: true
+  end
+end
+
+RSpec.describe Types::Post do
+  context "type and field matchers" do
+    subject { Types::Post }
+    it { should have_description("This is a Types::Post")}
+    it { should define_field("id").of_type(:ID).required.with_description("ID Description") }
+    it { should define_field("text").of_type(String).required }
+    it { should define_field("author").of_type(Types::Author).required }
+    it { should define_field("comments").of_type([Types::Comment]).optional }
+  end
+  context "argument matchers" do
+    subject { Types::QueryType }
+    it { should define_field("post").with_arguments(id: { required: true }) }
+  end
+  context "schema matchers" do
+    subject { Schema }
+    it { should define_query_type(Types::QueryType) }
+    it { should define_mutation_type(Types::MutationType) }
+    it { should define_subscription_type(Types::SubscriptionType) }
+    it { should have_max_depth(200) }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ni3t/shoulda-matchers-graphql.
+
+

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 "shoulda/matchers/graphql"
+
+# 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(__FILE__)

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/shoulda/matchers/graphql.rb

@@ -0,0 +1,14 @@
+require "shoulda/matchers/graphql/version"
+require "shoulda/matchers/graphql/fields"
+require "shoulda/matchers/graphql/types"
+require "shoulda/matchers/graphql/schema"
+
+module Shoulda
+  module Matchers
+    # This module provides matchers for GraphQL
+
+    module Graphql
+      class Error < StandardError; end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields.rb

@@ -0,0 +1,7 @@
+require_relative "fields/field_matcher"
+require_relative "fields/define_field"
+require_relative "fields/of_type"
+require_relative "fields/optional"
+require_relative "fields/required"
+require_relative "fields/with_arguments"
+require_relative "fields/with_description"

data/lib/shoulda/matchers/graphql/fields/define_field.rb

@@ -0,0 +1,55 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        # The 'define_field' matcher is the starting point for field-level validations.
+        #
+        #     class PostType < GraphQL::Schema::Object
+        #       field :some_field, String, null: false
+        #     end
+        #
+        #     #RSpec
+        #     RSpec.describe PostType do
+        #       it { should have_field("some_field") }
+        #     end
+        #
+        # ## Qualifiers
+        #
+        # ### `of_type`
+        #
+        # Use `of_type` if you want to test the return type of the field
+        #
+        #     class PostType < GraphQL::Schema::Object
+        #       field :some_field, String, null: false
+        #     end
+        #
+        #     #RSpec
+        #     RSpec.describe PostType do
+        #       it { should have_field("some_field").of_type(String) }
+        #     end
+        #
+
+        def define_field(field_name)
+          DefineField.new(field_name)
+        end
+
+        class DefineField < FieldMatcher
+          attr_accessor :field_name
+
+          def initialize(field_name)
+            super
+          end
+
+          def matches?(subject)
+            super(subject)
+            subject.respond_to?(:fields) && !subject.fields[field_name].nil?
+          end
+
+          def description
+            "define field '#@field_name'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/field_matcher.rb

@@ -0,0 +1,45 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class FieldMatcher
+          attr_reader :field_name
+
+          def initialize(field_name)
+            @field_name = field_name
+            @subject = nil
+          end
+
+          def description
+            "define field #@field_name"
+          end
+
+          def matches?(subject)
+            @subject = subject
+            self
+          end
+
+          def of_type(type_name)
+            OfType.new(@field_name, type_name)
+          end
+
+          def optional
+            Optional.new(@field_name)
+          end
+
+          def required
+            Required.new(@field_name)
+          end
+
+          def with_description(field_description)
+            WithDescription.new(@field_name, field_description)
+          end
+
+          def with_arguments(argument_hash)
+            WithArguments.new(@field_name, argument_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/of_type.rb

@@ -0,0 +1,33 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class OfType < FieldMatcher
+          attr_accessor :type_name
+
+          def initialize(field_name, type_name)
+            super(field_name)
+            @type_name = type_name == :ID ? "ID" : type_name
+          end
+
+          def matches?(subject)
+            super(subject)
+            subject_return_type == type_name
+          end
+
+          def description
+            super + ", of type #@type_name"
+          end
+
+          def failure_message
+            "expected '#@field_name' to be of type #@type_name, but it was #{subject_return_type} instead"
+          end
+
+          def subject_return_type
+            @subject.fields[@field_name].instance_variable_get("@return_type_expr")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/optional.rb

@@ -0,0 +1,25 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class Optional < FieldMatcher
+          def initialize(field_name)
+            super
+          end
+
+          def matches?(subject)
+            subject.fields[@field_name].type.class != GraphQL::Schema::NonNull
+          end
+
+          def failure_message
+            "expected #@field_name to be nullable, but it is not nullable."
+          end
+
+          def description
+            super + ", optional"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/required.rb

@@ -0,0 +1,26 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class Required < FieldMatcher
+          def initialize(field_name)
+            super
+          end
+
+          def matches?(subject)
+            super(subject)
+            @subject.fields[@field_name].type.class == GraphQL::Schema::NonNull
+          end
+
+          def description
+            super + ", required"
+          end
+
+          def failure_message
+            "expected '#{@subject.fields[@field_name]}' to be required, but it was not."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/with_arguments.rb

@@ -0,0 +1,48 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class WithArguments < FieldMatcher
+          def initialize(field_name, **args)
+            super(field_name)
+            @arguments = *args
+          end
+
+          def matches?(subject)
+            super(subject)
+            @arguments.map do |k, v|
+              tokens = k.to_s.split("_")
+              first, *rem = tokens
+              rem = rem.map(&:capitalize)
+              camelized = first + rem.join
+              if field_arguments[camelized].nil?
+                return false
+              end
+              #TODO: additional options checks, refactor into own module
+              if !v[:required].nil?
+                required = v[:required]
+                nullable = field_arguments[camelized].instance_variable_get("@null")
+                required == !nullable
+              else
+                true
+              end
+            end.all?
+          end
+
+          def description
+            args = @arguments.join(", ")
+            super + ", with argument(s) #{args}"
+          end
+
+          def field_arguments
+            @subject.fields[@field_name].instance_variable_get("@own_arguments")
+          end
+
+          def failure_message
+            "oops"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/fields/with_description.rb

@@ -0,0 +1,31 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Fields
+        class WithDescription < FieldMatcher
+          def initialize(field_name, field_description)
+            super(field_name)
+            @field_description = field_description
+          end
+
+          def matches?(subject)
+            super(subject)
+            subject_description.to_s == @field_description.to_s
+          end
+
+          def description
+            super + ", with description #@field_description"
+          end
+
+          def failure_message
+            "expected the field_description to be '#@field_description', but it was '#{subject_description}' instead."
+          end
+
+          def subject_description
+            @subject.fields[@field_name].description
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/schema.rb

@@ -0,0 +1,2 @@
+require_relative "schema/schema_matcher"
+require_relative "schema/define_query_type"

data/lib/shoulda/matchers/graphql/schema/define_query_type.rb

@@ -0,0 +1,36 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Schema
+        def define_query_type(query_type)
+          DefineQueryType.new(query_type)
+        end
+
+        class DefineQueryType < SchemaMatcher
+          attr_accessor :query_type
+
+          def initialize(query_type)
+            @query_type = query_type
+          end
+
+          def matches?(subject)
+            super(subject)
+            subject_query_type == query_type
+          end
+
+          def failure_message
+            "expected Schema to have query type #@query_type, but it was #{subject_query_type}"
+          end
+
+          def description
+            "define query type #@query_type"
+          end
+
+          def subject_query_type
+            @subject.instance_variable_get("@query_object")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/schema/schema_matcher.rb

@@ -0,0 +1,18 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Schema
+        class SchemaMatcher
+          def initialize
+            @subject = nil
+          end
+
+          def matches?(subject)
+            @subject = subject
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/types.rb

@@ -0,0 +1,2 @@
+require_relative "types/type_matcher"
+require_relative "types/have_description"

data/lib/shoulda/matchers/graphql/types/have_description.rb

@@ -0,0 +1,32 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Types
+        def have_description(type_description)
+          HaveDescription.new(type_description)
+        end
+
+        class HaveDescription < TypeMatcher
+          attr_accessor :type_description
+
+          def initialize(type_description)
+            @type_description = type_description
+          end
+
+          def matches?(subject)
+            super(subject)
+            @subject.description == type_description
+          end
+
+          def description
+            "have description '#@type_description'"
+          end
+
+          def failure_message
+            "expected #@subject to have description '#@type_description', but it was '#{@subject.description}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/types/type_matcher.rb

@@ -0,0 +1,20 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      module Types
+        class TypeMatcher
+          attr_reader :type
+
+          def initialize
+            @subject = nil
+          end
+
+          def matches?(subject)
+            @subject = subject
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/graphql/version.rb

@@ -0,0 +1,7 @@
+module Shoulda
+  module Matchers
+    module Graphql
+      VERSION = "0.1.0"
+    end
+  end
+end

data/shoulda-matchers-graphql.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shoulda/matchers/graphql/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "shoulda-matchers-graphql"
+  spec.version = Shoulda::Matchers::Graphql::VERSION
+  spec.authors = ["Nick Bell"]
+  spec.email = ["bell.nicholas.p@gmail.com"]
+  spec.licenses = ["MIT"]
+
+  spec.summary = %q{Shoulda style matchers for GraphQL}
+  spec.description = %q{Shoulda style matchers for GraphQL...}
+  spec.homepage = "https://github.com/ni3t/shoulda-matchers-graphql"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.19"
+
+  spec.add_development_dependency "shoulda-matchers", "~> 4.0.1"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: shoulda-matchers-graphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Bell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: Shoulda style matchers for GraphQL...
+email:
+- bell.nicholas.p@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shoulda/matchers/graphql.rb
+- lib/shoulda/matchers/graphql/fields.rb
+- lib/shoulda/matchers/graphql/fields/define_field.rb
+- lib/shoulda/matchers/graphql/fields/field_matcher.rb
+- lib/shoulda/matchers/graphql/fields/of_type.rb
+- lib/shoulda/matchers/graphql/fields/optional.rb
+- lib/shoulda/matchers/graphql/fields/required.rb
+- lib/shoulda/matchers/graphql/fields/with_arguments.rb
+- lib/shoulda/matchers/graphql/fields/with_description.rb
+- lib/shoulda/matchers/graphql/schema.rb
+- lib/shoulda/matchers/graphql/schema/define_query_type.rb
+- lib/shoulda/matchers/graphql/schema/schema_matcher.rb
+- lib/shoulda/matchers/graphql/types.rb
+- lib/shoulda/matchers/graphql/types/have_description.rb
+- lib/shoulda/matchers/graphql/types/type_matcher.rb
+- lib/shoulda/matchers/graphql/version.rb
+- shoulda-matchers-graphql.gemspec
+homepage: https://github.com/ni3t/shoulda-matchers-graphql
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Shoulda style matchers for GraphQL
+test_files: []