graphql-schema_directives 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 706240fbd69fe3d0ea90204ba750384c0d7c0ed3a3527fc6a73d082aa39f7f2e
+  data.tar.gz: c8e509e2f8ec18da0a796c39fd70e16b17e21ba9732a8fc563076d450ec73a70
+SHA512:
+  metadata.gz: 9a4b743c704ecd03f81d88e3d97ebce34a5f86b2c20f1cae78ac4b1462f61f586ff51a9a6685add1440023e1dce34099b8395a990c1f096cc9f509f1f4441f1e
+  data.tar.gz: 38edcc3f38b0bce7df416dd960db3d1e85add720bbf1a2b3aa185149738b089e5b01916fa6ef35da4eedb959cb448c4b07539023df438c4452d4cf24e128f4fd

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    graphql-schema_directives (0.0.1)
+      graphql (~> 1.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    graphql (1.11.6)
+    minitest (5.14.2)
+    rake (12.3.3)
+    warning (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  graphql-schema_directives!
+  minitest (~> 5.12)
+  rake (~> 12.0)
+  warning (~> 1.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Greg MacWilliam
+
+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,229 @@
+# Ruby GraphQL Schema Directives
+
+This gem extends [GraphQL Ruby](http://graphql-ruby.org/) to add support for custom schema directives that annotate an SDL. These annotations are useful for [Schema Stitching](https://www.graphql-tools.com/docs/stitch-directives-sdl), [Apollo Federation](https://www.apollographql.com/docs/federation/), and other proprietary uses.
+
+This gem is intentionally generic, versus the [apollo-federation](https://github.com/Gusto/apollo-federation-ruby) gem upon which it is based. The goals of this gem are much simpler:
+
+1. allow schema directives to be applied to any GraphQL element, and then printed into an annotated SDL.
+2. allow class-based schemas and parsed `GraphQL::Schema.from_definition` schemas to be combined and printed together.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Class-based schemas](#class-based-schemas)
+- [Schemas from definition](#schemas-from-definition)
+- [Schema Stitching SDL](#schema-stitching-sdl)
+
+## Installation
+
+Add to Gemfile:
+
+```ruby
+gem 'graphql-schema_directives'
+```
+
+Then install:
+
+```shell
+bundle install
+```
+
+## Class-based schemas
+
+There's a typed mixin available for extending all GraphQL schema members.
+
+### Schema classes
+
+Include the schema mixin:
+
+```ruby
+class MySchema < GraphQL::Schema
+  include GraphQL::SchemaDirectives::Schema
+end
+```
+
+This adds a `print_schema_with_directives` method to print an SDL that includes custom schema directives:
+
+```ruby
+MySchema.print_schema_with_directives
+```
+
+### Field, Object &amp; Interface classes
+
+Setup base abstracts:
+
+```ruby
+class BaseField < GraphQL::Schema::Field
+  include GraphQL::SchemaDirectives::Field
+end
+
+class BaseObject < GraphQL::Schema::Object
+  include GraphQL::SchemaDirectives::Object
+  field_class BaseField
+end
+
+module BaseInterface
+  include GraphQL::Schema::Interface
+  include GraphQL::SchemaDirectives::Interface
+  field_class BaseField
+end
+```
+
+Then extend into concrete implementations:
+
+```ruby
+module Spaceship
+  include BaseInterface
+  add_directive :attribute, { speed: 'average' }
+
+  field :name, String, null: false, directives: {
+    cost: { value: 'FIELD' },
+    public: nil
+  }
+end
+
+class XWing < BaseObject
+  implements Spaceship
+  add_directive :attribute, { speed: 'fast' }
+  add_directive :rebel
+
+  field :name, String, null: false, directives: {
+    cost: { value: 'FIELD' },
+    public: nil
+  }
+end
+```
+
+Prints from `schema.print_schema_with_directives` as:
+
+```graphql
+interface Spaceship @attribute(speed: "average") {
+  name: String! @cost(value: "FIELD") @public
+}
+
+type XWing @attribute(speed: "fast") @rebel {
+  name: String! @cost(value: "FIELD") @public
+}
+```
+
+### Argument &amp; InputObject classes
+
+Base abstracts:
+
+```ruby
+class BaseArgument < GraphQL::Schema::Argument
+  include GraphQL::SchemaDirectives::Argument
+end
+
+class BaseInputObject < GraphQL::Schema::InputObject
+  include GraphQL::SchemaDirectives::InputObject
+  argument_class BaseArgument
+end
+```
+
+Concrete implementation:
+
+```ruby
+class FormInput < BaseInputObject
+  add_directive :oneField
+  argument :choice, String, required: true, directives: {
+    cost: { value: 'INPUT' },
+    public: nil
+  }
+end
+```
+
+Prints as:
+
+```graphql
+input FormInput @oneField {
+  choice: String! @cost(value: "INPUT") @public
+}
+```
+
+### EnumValue &amp; Enum classes
+
+Base abstracts:
+
+```ruby
+class BaseEnumValue < GraphQL::Schema::EnumValue
+  include GraphQL::SchemaDirectives::EnumValue
+end
+
+class BaseEnum < GraphQL::Schema::Enum
+  include GraphQL::SchemaDirectives::Enum
+  enum_value_class BaseEnumValue
+end
+```
+
+Concrete implementation:
+
+```ruby
+class FormOption < BaseEnum
+  add_directive :dunno
+  value 'GET', directives: { cost: { value: 'READ' }, public: nil }
+  value 'SET', directives: { cost: { value: 'WRITE' }, public: nil }
+end
+```
+
+Prints as:
+
+```graphql
+enum FormOption @dunno {
+  GET @cost(value: "READ") @public
+  SET @cost(value: "WRITE") @public
+}
+```
+
+### Other classes
+
+Base abstracts:
+
+```ruby
+class BaseUnion < GraphQL::Schema::Union
+  include GraphQL::SchemaDirectives::Union
+end
+
+class BaseScalar < GraphQL::Schema::Scalar
+  include GraphQL::SchemaDirectives::Scalar
+end
+```
+
+## Schemas from definition
+
+You may also [parse and print SDLs](https://graphql-ruby.org/schema/sdl.html) using the gem's `from_definition` method:
+
+```rb
+schema = GraphQL::SchemaDirectives.from_definition(type_defs)
+puts schema.print_schema_with_directives
+```
+
+The local `from_definition` method accepts all the same options as [the underlying method](https://graphql-ruby.org/api-doc/1.11.6/GraphQL/Schema#from_definition-class_method). Calling `print_schema_with_directives` works exactly like the [default printer](https://graphql-ruby.org/api-doc/1.11.6/GraphQL/Language/Printer.html#print-instance_method) when operating on an unmodified document parse (elements with an original AST will print their schema directives natively).
+
+This feature becomes useful when you start modifying a parsed document with class-based additions:
+
+```rb
+module Spaceship
+  include GraphQL::Schema::Interface
+  include GraphQL::SchemaDirectives::Interface
+  field :name, String, null: false, directives: { public: nil }
+end
+
+type_defs = %(
+  type XWing {
+    name: String! @public
+  }
+  type Query {
+    ship: XWing
+  }
+  schema {
+    query: Query
+  }
+)
+
+schema = GraphQL::SchemaDirectives.from_definition(type_defs)
+schema.types['XWing'].implements(Spaceship)
+puts schema.print_schema_with_directives
+```
+
+Using `print_schema_with_directives` will include directives from the original AST as well as directives applied to added classes.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t, args|
+  puts args
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/graphql-schema_directives.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/schema_directives/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-schema_directives'
+  spec.version       = GraphQL::SchemaDirectives::VERSION
+  spec.authors       = ['Greg MacWilliam']
+  spec.summary       = 'Schema directives for graphql-ruby'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/gmac/graphql-schema-directives-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.metadata    = {
+    'homepage_uri' => 'https://github.com/gmac/graphql-schema-directives-ruby',
+    'changelog_uri' => 'https://github.com/gmac/graphql-schema-directives-ruby/releases',
+    'source_code_uri' => 'https://github.com/gmac/graphql-schema-directives-ruby',
+    'bug_tracker_uri' => 'https://github.com/gmac/graphql-schema-directives-ruby/issues',
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^test/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'graphql', '~> 1.9'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.12'
+  spec.add_development_dependency 'warning', '~> 1.1'
+end

data/lib/graphql-schema_directives.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require 'graphql/schema_directives'

data/lib/graphql/schema_directives.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'graphql/schema_directives/version'
+require 'graphql/schema_directives/types'
+
+module GraphQL::SchemaDirectives
+  def self.from_definition(*args, **kwargs, &block)
+    schema = GraphQL::Schema.from_definition(*args, **kwargs, &block)
+    schema.include(GraphQL::SchemaDirectives::Schema)
+    schema
+  end
+end

data/lib/graphql/schema_directives/has_directives.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GraphQL::SchemaDirectives
+  module HasDirectives
+    attr_reader :schema_directives
+
+    def add_directive(name, arguments=nil)
+      raise ArgumentError, 'directive name must be a string or symbol' unless name.is_a?(String) || name.is_a?(Symbol)
+      raise ArgumentError, 'directive arguments must be a Hash or nil' unless arguments.is_a?(Hash) || arguments.nil?
+      @schema_directives ||= []
+      @schema_directives << {
+        name: name,
+        arguments: arguments
+      }
+    end
+
+    def to_graphql
+      type = super
+      type.metadata[:schema_directives] = @schema_directives
+      type
+    end
+  end
+end

data/lib/graphql/schema_directives/initialize_with_directives.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative './has_directives'
+
+module GraphQL::SchemaDirectives
+  module InitializeWithDirectives
+    include HasDirectives
+
+    def initialize(*args, directives: nil, **kwargs, &block)
+      if directives
+        raise ArgumentError, 'schema directives must be a hash' unless directives.is_a?(Hash)
+        directives.each_pair { |name, arguments| add_directive(name, arguments) }
+      end
+      super(*args, **kwargs, &block)
+    end
+  end
+end

data/lib/graphql/schema_directives/schema_directives_document_from_schema_definition.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module GraphQL::SchemaDirectives
+  class SchemaDirectivesDocumentFromSchemaDefinition < GraphQL::Language::DocumentFromSchemaDefinition
+
+    def build_object_type_node(object_type)
+      node = super
+      merge_directives(node, object_type)
+    end
+
+    def build_interface_type_node(interface_type)
+      node = super
+      merge_directives(node, interface_type)
+    end
+
+    def build_field_node(field_type)
+      node = super
+      merge_directives(node, field_type)
+    end
+
+    def build_input_object_node(input_object)
+      node = super
+      merge_directives(node, input_object)
+    end
+
+    def build_argument_node(argument)
+      node = super
+      merge_directives(node, argument)
+    end
+
+    def build_union_type_node(union_type)
+      node = super
+      merge_directives(node, union_type)
+    end
+
+    def build_enum_type_node(enum_type)
+      node = super
+      merge_directives(node, enum_type)
+    end
+
+    def build_enum_value_node(enum_value)
+      node = super
+      merge_directives(node, enum_value)
+    end
+
+    private
+
+    def merge_directives(node, member)
+      directives = if member.respond_to?(:metadata)
+        member.metadata[:schema_directives]
+      elsif member.respond_to?(:schema_directives)
+        member.schema_directives
+      end
+
+      (directives || []).each do |directive|
+        node = node.merge_directive(
+          name: directive[:name],
+          arguments: build_arguments_node(directive[:arguments]),
+        )
+      end
+      node
+    end
+
+    def build_arguments_node(arguments)
+      (arguments || {}).map do |name, values|
+        GraphQL::Language::Nodes::Argument.new(name: name, value: values)
+      end
+    end
+  end
+end

data/lib/graphql/schema_directives/types.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require_relative './has_directives'
+require_relative './initialize_with_directives'
+require_relative './schema_directives_document_from_schema_definition'
+
+module GraphQL::SchemaDirectives
+  module Argument
+    include InitializeWithDirectives
+  end
+
+  module Enum
+    def self.included(klass)
+      klass.extend(HasDirectives)
+    end
+  end
+
+  module EnumValue
+    include InitializeWithDirectives
+  end
+
+  module Field
+    include InitializeWithDirectives
+  end
+
+  module InputObject
+    def self.included(klass)
+      klass.extend(HasDirectives)
+    end
+  end
+
+  module Interface
+    def self.included(klass)
+      klass.definition_methods do
+        include HasDirectives
+      end
+    end
+  end
+
+  module Object
+    def self.included(klass)
+      klass.extend(HasDirectives)
+    end
+  end
+
+  module Scalar
+    def self.included(klass)
+      klass.extend(HasDirectives)
+    end
+  end
+
+  module Schema
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def print_schema_with_directives(context: nil)
+        document_from_schema = SchemaDirectivesDocumentFromSchemaDefinition.new(self, context: context)
+        GraphQL::Language::Printer.new.print(document_from_schema.document)
+      end
+    end
+  end
+
+  module Union
+    def self.included(klass)
+      klass.extend(HasDirectives)
+    end
+  end
+end

data/lib/graphql/schema_directives/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module SchemaDirectives
+    VERSION = '0.0.2'
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: graphql-schema_directives
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Greg MacWilliam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Schema directives for graphql-ruby
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- graphql-schema_directives.gemspec
+- lib/graphql-schema_directives.rb
+- lib/graphql/schema_directives.rb
+- lib/graphql/schema_directives/has_directives.rb
+- lib/graphql/schema_directives/initialize_with_directives.rb
+- lib/graphql/schema_directives/schema_directives_document_from_schema_definition.rb
+- lib/graphql/schema_directives/types.rb
+- lib/graphql/schema_directives/version.rb
+homepage: https://github.com/gmac/graphql-schema-directives-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gmac/graphql-schema-directives-ruby
+  changelog_uri: https://github.com/gmac/graphql-schema-directives-ruby/releases
+  source_code_uri: https://github.com/gmac/graphql-schema-directives-ruby
+  bug_tracker_uri: https://github.com/gmac/graphql-schema-directives-ruby/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Schema directives for graphql-ruby
+test_files: []