rspec-graphql_assistant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0658fbabb671fea77f65b9ac7550f6e4fa3b08a069b3160165db182769b817f7'
+  data.tar.gz: 9f205605a4f6c88fd1e6f4cb1449e973dfff1fe9f717fd6b23892d4434f3dd5b
+SHA512:
+  metadata.gz: 13ce16383005507827f2e9bf9bdb4b9f7f7ed0caf06da557a9abf1b40bb9b9d1bd6ef880bd74fb26f57f6d618734ec0e2a3ca991ebee9b8dbad9a4e43b5ad81f
+  data.tar.gz: a79f5a0fad5a8220c930d3fc633c510fd1973df313e965c72e4ada88dc3da8601ef461b91350c99b6bea2f29241fe205fcb707bba512b3b65b90d3650e6ba961

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-graphql_assistant.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "activesupport"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    rspec-graphql_assistant (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  pry (~> 0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-graphql_assistant!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ivan Lopatin
+
+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,62 @@
+# Rspec::GraphqlAssistant
+Helps you to generate query for testing GraphQL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-graphql_assistant'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-graphql_assistant
+
+## Usage
+
+```ruby
+RSpec.configure do |config|
+  config.include RSpec::GraphqlAssistant::Helpers
+end
+```
+
+```ruby
+graphql_mutation('updatePost', { post_id: 1, content: "some test" }, [:id, :content])
+```
+
+produce this one query
+```gql
+mutation {
+  updatePost(input: {postId: 1, content: "some text"}) {
+    id
+    content
+  }
+}
+
+```
+Examples of query and subscription
+```ruby
+args = {post_id: 1}
+response = [:id, :name]
+
+graphql_query('queryName', args, response)
+
+graphql_subscription('subscriptionName', args, response)
+```
+
+Work in progress and now only supports inline syntax. Which means without passing variables. Later try to cover both cases
+Cheers
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ginray/rspec-graphql_assistant.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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_assistant"
+
+# 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/rspec/graphql_assistant.rb

@@ -0,0 +1,17 @@
+require "rspec/graphql_assistant/version"
+require 'active_support'
+require 'active_support/core_ext'
+require 'rspec/graphql_assistant/matchers'
+require 'rspec/graphql_assistant/has_attrs'
+require 'rspec/graphql_assistant/contain_attrs'
+require 'rspec/graphql_assistant/query_builder'
+require 'rspec/graphql_assistant/argument_builder'
+require 'rspec/graphql_assistant/argument_builder_with_vars'
+require 'rspec/graphql_assistant/helpers'
+
+module Rspec
+  module GraphqlAssistant
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rspec/graphql_assistant/argument_builder.rb

@@ -0,0 +1,56 @@
+module RSpec
+  module GraphqlAssistant
+    class ArgumentBuilder
+      attr_reader :arguments_hash
+
+      def initialize(arguments_hash)
+        @arguments_hash = arguments_hash
+      end
+
+      def call
+        process_hash(arguments_hash)
+      end
+
+      private
+
+      def process_root(arg)
+        return process_hash(arg) if arg.is_a?(Hash)
+        return process_array(arg) if arg.is_a?(Array)
+        process_scalar(arg) if arg.is_a?(Symbol) || arg.is_a?(String) || arg.is_a?(Numeric)
+      end
+
+      def process_scalar(arg)
+        arg = "\"#{arg}\"" if arg.is_a?(Symbol) || arg.is_a?(String)
+        arg
+      end
+
+      def process_array(arg)
+        result = []
+        arg.each do |item|
+          result << process_root(item)
+        end
+        line = result.map { |item| "{#{item}}"}.join(', ')
+      end
+
+      def process_hash(arg)
+        result = []
+        arg.each do |k, v|
+          arg_name = k
+          arg_name = k.to_s.camelize(:lower) if k.is_a?(Symbol)
+          if is_scalar?(v)
+            result << "#{arg_name}: #{process_scalar(v)}"
+          elsif v.is_a?(Array)
+            result << "#{arg_name}: [ #{process_root(v)} ]"
+          else
+            result << "#{arg_name}: { #{process_root(v)} }"
+          end
+        end
+        result.join(', ')
+      end
+
+      def is_scalar?(arg)
+        arg.is_a?(Symbol) || arg.is_a?(String) || arg.is_a?(Numeric)
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/argument_builder_with_vars.rb

@@ -0,0 +1,51 @@
+module RSpec
+  module GraphqlAssistant
+    class ArgumentBuilderWithVars
+      attr_reader :arguments_arr
+
+      def initialize(arguments_arr)
+        @arguments_arr = arguments_arr
+      end
+
+      def call
+        result = []
+        arguments_arr.each do |arg|
+          result << process_root(arg)
+        end
+        result.join ', '
+      end
+
+      private
+
+      def process_root(arg)
+        return process_hash(arg) if arg.is_a?(Hash)
+        return process_array(arg) if arg.is_a?(Array)
+        process_string_or_symbol(arg) if arg.is_a?(Symbol) || arg.is_a?(String)
+      end
+
+      def process_string_or_symbol(arg)
+        arg = arg.to_s.camelize(:lower) if arg.is_a?(Symbol)
+        "#{arg}: $#{arg}"
+      end
+
+      def process_array(arg)
+        result = []
+        arg.each do |item|
+          result << process_root(item)
+        end
+        result.join(', ')
+      end
+
+      def process_hash(arg)
+        result = ''
+        arg.each do |k, v|
+          arg_name = k
+          arg_name = k.to_s.camelize(:lower) if k.is_a?(Symbol)
+          arg_value = process_root(v)
+          result << "#{arg_name}: { #{arg_value} }"
+        end
+        result
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/contain_attrs.rb

@@ -0,0 +1,31 @@
+module RSpec
+  module GraphqlAssistant
+    class ContainAttrs
+      attr_reader :sample, :expected, :key
+
+      def initialize(key, expected)
+        @expected = expected
+        @key = key
+      end
+
+      def matches?(actual)
+        actual_copy = actual.with_indifferent_access
+        value = actual_copy.dig(:data, key)
+        res = true
+        expected.each do |k,v|
+          res = value[k] == v
+          break unless res
+        end
+        res
+      end
+
+      def failure_message
+        "'#{key}' not equal attributes '#{expected}'"
+      end
+
+      def description
+        "'#{key}' has attributes '#{expected}'"
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/has_attrs.rb

@@ -0,0 +1,27 @@
+module RSpec
+  module GraphqlAssistant
+    class HasAttrs
+      attr_reader :sample, :expected, :key
+
+      def initialize(key, expected)
+        @expected = expected
+        @key = key
+      end
+
+      def matches?(actual)
+        value = actual.dig('data', key)
+        return value.any? { |k,_v| expected.include? k } if value.is_a?(Hash)
+
+        value.all? { |el| el.any? { |k,_v| expected.include? k } } if value.is_a?(Array)
+      end
+
+      def failure_message
+        "'#{key}' not include all attributes '#{expected}'"
+      end
+
+      def description
+        "'#{key}' has attributes '#{expected}'"
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/helpers.rb

@@ -0,0 +1,18 @@
+module RSpec
+  module GraphqlAssistant
+    module Helpers
+
+      def graphql_mutation(name, args, response)
+        QueryBuilder.new(:mutation, name, args, response).call
+      end
+
+      def graphql_query(name, args, response)
+        QueryBuilder.new(:query, name, args, response).call
+      end
+
+      def graphql_subscription(name, args, response)
+        QueryBuilder.new(:subscription, name, args, response).call
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/matchers.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Matchers
+    def has_graphql_attrs(key, expected)
+      RSpec::GraphqlAssistant::HasAttrs.new(key, expected)
+    end
+
+    def contain_graphql_attrs(key, expected)
+      RSpec::GraphqlAssistant::ContainAttrs.new(key, expected)
+    end
+  end
+end

data/lib/rspec/graphql_assistant/query_builder.rb

@@ -0,0 +1,42 @@
+module RSpec
+  module GraphqlAssistant
+    class QueryBuilder
+      attr_reader :name, :args, :response, :type
+      def initialize(type, name, args, response)
+        @type = type
+        @name = name
+        @args = args
+        @response = response
+      end
+
+
+      def call
+        template % {type: type, name: name, args: transform_args(args), response: transform_response(response)}
+      end
+
+      private
+
+      def transform_args(args)
+        return if args.blank?
+        "(#{ArgumentBuilder.new(args).call})"
+      end
+
+      def transform_response(response)
+        response.map do |item|
+          next item.to_s.camelize(:lower) if item.is_a?(Symbol)
+          item
+        end.join("\n")
+      end
+
+      def template
+        <<-GQL
+%{type} {
+ %{name}%{args} {
+  %{response}
+ }
+}
+        GQL
+      end
+    end
+  end
+end

data/lib/rspec/graphql_assistant/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module GraphqlAssistant
+    VERSION = "0.1.0"
+  end
+end

data/rspec-graphql_assistant.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rspec/graphql_assistant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-graphql_assistant"
+  spec.version       = Rspec::GraphqlAssistant::VERSION
+  spec.authors       = ["Ivan Lopatin"]
+  spec.email         = ["gingray.dev@gmail.com"]
+
+  spec.summary       = %q{Collection of RSpec helpers to easy test GraphQL query, mutation, subscription}
+  spec.description   = %q{Collection of RSpec helpers to easy test GraphQL query, mutation, subscription}
+  spec.homepage      = "https://github.com/gingray/rspec-graphql_assistant"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gingray/rspec-graphql_assistant"
+  spec.metadata["changelog_uri"] = "https://github.com/gingray/rspec-graphql_assistant"
+
+  # 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 'pry', '~> 0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rspec-graphql_assistant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Lopatin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-15 00:00:00.000000000 Z
+dependencies:
+- !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: Collection of RSpec helpers to easy test GraphQL query, mutation, subscription
+email:
+- gingray.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/graphql_assistant.rb
+- lib/rspec/graphql_assistant/argument_builder.rb
+- lib/rspec/graphql_assistant/argument_builder_with_vars.rb
+- lib/rspec/graphql_assistant/contain_attrs.rb
+- lib/rspec/graphql_assistant/has_attrs.rb
+- lib/rspec/graphql_assistant/helpers.rb
+- lib/rspec/graphql_assistant/matchers.rb
+- lib/rspec/graphql_assistant/query_builder.rb
+- lib/rspec/graphql_assistant/version.rb
+- rspec-graphql_assistant.gemspec
+homepage: https://github.com/gingray/rspec-graphql_assistant
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gingray/rspec-graphql_assistant
+  source_code_uri: https://github.com/gingray/rspec-graphql_assistant
+  changelog_uri: https://github.com/gingray/rspec-graphql_assistant
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Collection of RSpec helpers to easy test GraphQL query, mutation, subscription
+test_files: []