graphql_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5baf3ee59c551fd336943f2729bab7711042b8ad
+  data.tar.gz: 077522f2b78fde33cf8f4b212c75501ddc8c259e
+SHA512:
+  metadata.gz: 24573fc0b1815b5afcebf6d71895f112f8fbd20919dd195940223187eecb453f0d801a09e1cf6d1e9074e94aa9f0b13408c08979e184d8b0b384067c0230accf
+  data.tar.gz: a291436003bf8001294dc41056406763cbdb3a2b2da25cde900fbb03d3dde7eee15b3695fcf64d385e74964f4681be47d774f3bca3cf949955a342bd40a210df

data/.gitignore

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

data/.travis.yml

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

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+Types of contributions we welcome:
+
+* Opening issue for bugs
+* Bug fixes
+* Documentation and/or clearer interfaces
+
+## Proposing Features
+
+The focus on this project is on providing a convenient way to access
+the schema for code generators targetting different langauges.
+Features that aren't relevant for this use case are less likely to
+be merged. When in doubt, open an issue first to propose the issue
+so that we can confirm that we are interested in a pull request to
+implement it.
+
+## How To Contribute
+
+1. Fork the [repository in github](https://github.com/Shopify/graphql_schema)
+2. Create your feature branch (`git checkout -b fix-feature`)
+3. Commit your changes (`git commit -am 'fix: Summarize change'`)
+3. Make sure all tests pass (`bundle exec rake`)
+4. Push to the branch (`git push origin fix-feature`)
+5. [Create new pull request](https://github.com/Shopify/graphql_schema/pulls)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shopify
+
+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,50 @@
+# GraphQL Schema
+
+Classes to more conveniently access the GraphQL instrospection
+result rather than using the parsed json directly as a hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql_schema'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql_schema
+
+## Usage
+
+```ruby
+require 'graphql_schema'
+require 'json'
+
+introspection_result = JSON.parse(File.read("schema.json"))
+schema = GraphQLSchema.new(introspection_result)
+schema.types.select(&:object_type?).each do |type|
+  type.fields.each do |field|
+    puts "#{field.name} -> #{field.type.name}"
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+
+See our [contributing guidelines](CONTRIBUTING.md) for more information.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql_schema"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/graphql_schema.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql_schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql_schema"
+  spec.version       = GraphQLSchema::VERSION
+  spec.authors       = ["Dylan Thacker-Smith"]
+  spec.email         = ["gems@shopify.com"]
+
+  spec.summary       = "Classes for convenient use of GraphQL introspection result"
+  spec.homepage      = "https://github.com/Shopify/graphql_schema"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "graphql", "~> 1.2"
+  spec.add_development_dependency "byebug", '~> 9.0' if RUBY_ENGINE == 'ruby'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/graphql_schema/version.rb

@@ -0,0 +1,3 @@
+class GraphQLSchema
+  VERSION = "0.1.0"
+end

data/lib/graphql_schema.rb

@@ -0,0 +1,222 @@
+require "graphql_schema/version"
+require 'set'
+
+class GraphQLSchema
+  def initialize(instrospection_result)
+    @hash = instrospection_result.fetch('data').fetch('__schema')
+  end
+
+  def root_name?(type_name)
+    type_name == query_root_name || type_name == mutation_root_name
+  end
+
+  def query_root_name
+    @query_root_name ||= @hash.fetch('queryType').fetch('name')
+  end
+
+  def mutation_root_name
+    @mutation_root_name ||= @hash.fetch('mutationType', {}).fetch('name')
+  end
+
+  def types
+    @types ||= @hash.fetch('types').map{ |type_hash| TypeDefinition.new(type_hash) }.sort_by(&:name)
+  end
+
+  module NamedHash
+    def name
+      @hash.fetch('name')
+    end
+
+    def camelize_name
+      @camelize_name ||= begin
+        words = split_name.map(&:capitalize)
+        words[0] = words[0].downcase
+        words.join
+      end
+    end
+
+    def classify_name
+      @classify_name ||= split_name.map(&:capitalize).join
+    end
+
+    def upcase_name
+      @upcase_name ||= split_name.join("_").upcase
+    end
+
+    private
+
+    def split_name
+      @split_name ||= name.gsub(/([a-z])([A-Z0-9])/) { "#{$1}_#{$2}" }.split("_")
+    end
+  end
+
+  module Deprecatable
+    def deprecated?
+      @hash.fetch('isDeprecated')
+    end
+
+    def deprecation_reason
+      @hash.fetch('deprecationReason')
+    end
+  end
+
+  class Argument
+    include NamedHash
+
+    def initialize(arg_hash)
+      @hash = arg_hash
+    end
+
+    def type
+      @type ||= TypeDeclaration.new(@hash.fetch('type'))
+    end
+  end
+
+  class Field
+    include NamedHash
+    include Deprecatable
+
+    def initialize(field_hash)
+      @hash = field_hash
+    end
+
+    def args
+      @args ||= @hash.fetch('args').map{ |arg_hash| Argument.new(arg_hash) }
+    end
+
+    def required_args
+      @required_args ||= args.select{ |arg| arg.type.non_null? }
+    end
+
+    def optional_args
+      @optional_args ||= args.reject{ |arg| arg.type.non_null? }
+    end
+
+    def type
+      @type ||= TypeDeclaration.new(@hash.fetch('type'))
+    end
+
+    def subfields?
+      type.subfields?
+    end
+  end
+
+  class EnumValue
+    include NamedHash
+    include Deprecatable
+
+    def initialize(enum_value_hash)
+      @hash = enum_value_hash
+    end
+  end
+
+  class Type
+    include NamedHash
+
+    BUILTIN = %w(Int Float String Boolean ID).to_set
+
+    def initialize(type_hash)
+      @hash = type_hash
+    end
+
+    def kind
+      @hash.fetch('kind')
+    end
+
+    def scalar?
+      kind == 'SCALAR'
+    end
+
+    def object?
+      kind == 'OBJECT'
+    end
+
+    def input_object?
+      kind == 'INPUT_OBJECT'
+    end
+
+    def interface?
+      kind == 'INTERFACE'
+    end
+
+    def union?
+      kind == 'UNION'
+    end
+
+    def list?
+      kind == 'LIST'
+    end
+
+    def builtin?
+      name.start_with?("__") || BUILTIN.include?(name)
+    end
+  end
+
+  class TypeDeclaration < Type
+    def of_type
+      @of_type ||= TypeDeclaration.new(@hash.fetch('ofType'))
+    end
+
+    def non_null?
+      kind == 'NON_NULL'
+    end
+
+    def unwrap
+      case kind
+      when 'NON_NULL', 'LIST'
+        of_type.unwrap
+      else
+        self
+      end
+    end
+
+    def unwrap_non_null
+      non_null? ? of_type.unwrap_non_null : self
+    end
+
+    def subfields?
+      case unwrap.kind
+      when 'OBJECT', 'INTERFACE', 'UNION'
+        true
+      else
+        false
+      end
+    end
+  end
+
+  class TypeDefinition < Type
+    def fields(include_deprecated: false)
+      @fields ||= @hash.fetch('fields').map{ |field_hash| Field.new(field_hash) }
+      include_deprecated ? @fields : @fields.reject(&:deprecated?)
+    end
+
+    def input_fields
+      @input_fields ||= @hash.fetch('inputFields').map{ |field_hash| Field.new(field_hash) }
+    end
+
+    def required_input_fields
+      @required_fields ||= input_fields.select{ |field| field.type.non_null? }
+    end
+
+    def optional_input_fields
+      @optional_fields ||= input_fields.reject{ |field| field.type.non_null? }
+    end
+
+    def interfaces
+      @interfaces ||= @hash.fetch('interfaces').map{ |type_hash| TypeDeclaration.new(type_hash) }.sort_by(&:name)
+    end
+
+    def implement?(interface_name)
+      interfaces.map(&:name).include?(interface_name)
+    end
+
+    def possible_types
+      @possible_types ||= @hash.fetch('possibleTypes').map{ |type_hash| TypeDeclaration.new(type_hash) }.sort_by(&:name)
+    end
+
+    def enum_values(include_deprecated: false)
+      @enum_values ||= @hash.fetch('enumValues').map{ |value_hash| EnumValue.new(value_hash) }.sort_by(&:name)
+      include_deprecated ? @enum_values : @enum_values.reject(&:deprecated?)
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: graphql_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Thacker-Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql_schema.gemspec
+- lib/graphql_schema.rb
+- lib/graphql_schema/version.rb
+homepage: https://github.com/Shopify/graphql_schema
+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.1
+signing_key: 
+specification_version: 4
+summary: Classes for convenient use of GraphQL introspection result
+test_files: []