graphql-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95ab4bc20c02f63be2acd6f1383fd57184719a7e
+  data.tar.gz: 79679c4f467ceef22e31677a22b4706011c555c6
+SHA512:
+  metadata.gz: d4d9f76f49551625f2509138f44e90bae1e5643ea736b1b949a2efbd66366acb262b8710813a1afe401515c8525b788ca95a77f60163a9ee1c3c0130c148b418
+  data.tar.gz: 087bfd499ba9196fbd85c6026dd16911b0f270cc81fd162782ad0d1a70822112d55bf745906f03ab21c5d7ea196ddd80fa99c76ee01a776b28819ae0725dc4ec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/output/
+/test/graphql-docs/fixtures/output/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.1
+
+sudo: false
+cache: bundler
+
+git:
+  depth: 10

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rubocop', require: false
+
+# Specify your gem's dependencies in graphql-docs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Garen Torikian
+
+MIT License
+
+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,86 @@
+# GraphQLDocs
+
+Easily generate beautiful documentation from your GraphQL schema.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-docs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-docs
+
+## Usage
+
+Simple! Call `GraphQLDocs.generate`, taking care to pass in the GraphQL endpoint:
+
+``` ruby
+GraphQLDocs.build(url: "http://graphql.org/swapi-graphql/")
+```
+
+If you already have the JSON locally, great! Call the same method with `path` instead:
+
+``` ruby
+GraphQLDocs.build(path: "location/to/sw-api.json")
+```
+
+If your GraphQL endpoint requires authentication, you can provide a username or password, or an access token:
+
+``` ruby
+options = {
+  url: "http://graphql.org/swapi-graphql/"
+  login: "gjtorikian",
+  password: "lolnowai"
+}
+GraphQLDocs.build(options)
+
+options = {
+  url: "http://graphql.org/swapi-graphql/"
+  access_token: "something123"
+}
+
+GraphQLDocs.build(options)
+```
+
+## Breakdown
+
+There are three phases going on in one little `GraphQLDocs.build` call:
+
+* The GraphQL JSON is _fetched_ (if you passed `url`) through `GraphQL::Client` (or simply read if you passed `path`).
+* `GraphQL::Parser` manipulates that JSON into a slightly saner format.
+* `GraphQL::Generator` takes that JSON and converts it into HTML.
+
+If you wanted to, you could break these calls up individually:
+
+``` ruby
+client = GraphQLDocs::Client.new(options)
+response = client.fetch
+
+# do something
+
+parser = GraphQLDocs::Parser.new(response, options)
+parsed_schema = parser.parse
+
+# do something else
+generator = Generator.new(parsed_schema, options)
+
+generator.generate
+```
+
+## Generating output
+
+The HTML generation process uses [html-pipeline](https://github.com/jch/html-pipeline) and ERB to style the output. There are a bunch of default options provided for you, but feel free to override any of these. The *Configuration* section below has more information on what you can change.
+
+### Herlper methods
+
+## Development
+
+After checking out the repo, run `script/bootstrap` 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.

data/Rakefile

@@ -0,0 +1,23 @@
+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
+
+task :console do
+  require 'pry'
+  require 'graphql-docs'
+
+  def reload!
+    files = $LOADED_FEATURES.select { |feat| feat =~ /\/graphql-docs\// }
+    files.each { |file| load file }
+  end
+
+  ARGV.clear
+  Pry.start
+end

data/graphql-docs.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql-docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-docs'
+  spec.version       = GraphQLDocs::VERSION
+  spec.authors       = ['Garen Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+
+  spec.summary       = 'Easily generate beautiful documentation from your GraphQL schema.'
+  spec.homepage      = 'https://github.com/gjtorikian/graphql-docs'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.11'
+  spec.add_dependency 'graphql', '~> 1.4'
+
+  # rendering
+  spec.add_dependency 'html-pipeline', '2.5.0'
+  spec.add_dependency 'github-markdown', '0.6.9'
+  spec.add_dependency 'extended-markdown-filter', '~> 0.4'
+  spec.add_dependency 'gemoji', '2.1.0'
+  spec.add_dependency 'page-toc-filter', '~> 0.0.1'
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-focus', '~> 1.1'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop-github'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/lib/graphql-docs.rb

@@ -0,0 +1,40 @@
+require 'graphql-docs/client'
+require 'graphql-docs/configuration'
+require 'graphql-docs/generator'
+require 'graphql-docs/parser'
+require 'graphql-docs/renderer'
+require 'graphql-docs/version'
+
+begin
+  require 'awesome_print'
+rescue LoadError; end
+
+module GraphQLDocs
+  class << self
+    def build(options)
+      options = GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS.merge(options)
+
+      if options[:url].nil? && options[:path].nil?
+        fail ArgumentError, 'No :url or :path provided!'
+      end
+
+      if !options[:url].nil? && !options[:path].nil?
+        fail ArgumentError, 'You can\'t pass both :url and :path!'
+      end
+
+      if options[:url]
+        client = GraphQLDocs::Client.new(options)
+        response = client.fetch
+      else
+        response = File.read(options[:path])
+      end
+
+      parser = GraphQLDocs::Parser.new(response, options)
+      parsed_schema = parser.parse
+
+      generator = Generator.new(parsed_schema, options)
+
+      generator.generate
+    end
+  end
+end

data/lib/graphql-docs/client.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+require 'graphql'
+
+module GraphQLDocs
+  class Client
+    attr_accessor :faraday
+
+    def initialize(options)
+      @login = options[:login]
+      @password = options[:password]
+
+      if @login.nil? && !@password.nil?
+        fail ArgumentError, 'Client provided a login, but no password!'
+      end
+
+      if !@login.nil? && @password.nil?
+        fail ArgumentError, 'Client provided a password, but no login!'
+      end
+
+      @access_token = options[:access_token]
+
+      @url = options[:url]
+      @faraday = Faraday.new(url: @url)
+
+      if @login && @password
+        @faraday.basic_auth(@login, @password)
+      elsif  @access_token
+        @faraday.authorization('token', @access_token)
+      end
+    end
+
+    def fetch
+      @faraday.post do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.body = "{ \"query\": \"#{GraphQL::Introspection::INTROSPECTION_QUERY.gsub("\n", '')}\" }"
+      end
+    end
+
+    def inspect
+      inspected = super
+
+      # mask password
+      inspected = inspected.gsub! @password, '*******' if @password
+
+      # Only show last 4 of token, secret
+      if @access_token
+        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      end
+
+      inspected
+    end
+  end
+end

data/lib/graphql-docs/configuration.rb

@@ -0,0 +1,35 @@
+module GraphQLDocs
+  module Configuration
+    GRAPHQLDOCS_DEFAULTS = {
+      # Client
+      access_token: nil,
+      login: nil,
+      password: nil,
+      path: nil,
+      url: nil,
+
+      # Generating
+      output_dir: './output/',
+      pipeline_config: {
+        pipeline:
+          %i(ExtendedMarkdownFilter
+           EmojiFilter
+           PageTocFilter),
+        context: {
+          gfm: false,
+          asset_root: 'https://a248.e.akamai.net/assets.github.com/images/icons'
+        }
+      },
+      templates: {
+        includes: "#{File.dirname(__FILE__)}/layouts/includes",
+        objects: "#{File.dirname(__FILE__)}/layouts/graphql_objects.html",
+        mutations: "#{File.dirname(__FILE__)}/layouts/graphql_mutations.html",
+        interfaces: "#{File.dirname(__FILE__)}/layouts/graphql_interfaces.html",
+        enums: "#{File.dirname(__FILE__)}/layouts/graphql_enums.html",
+        unions: "#{File.dirname(__FILE__)}/layouts/graphql_unions.html",
+        input_objects: "#{File.dirname(__FILE__)}/layouts/graphql_input_objects.html",
+        scalars: "#{File.dirname(__FILE__)}/layouts/graphql_scalars.html"
+      }
+    }
+  end
+end

data/lib/graphql-docs/generator.rb

@@ -0,0 +1,140 @@
+require 'erb'
+require 'graphql-docs/generator/helpers'
+
+module GraphQLDocs
+  class Generator
+    include Helpers
+
+    def initialize(parsed_schema, options)
+      @parsed_schema = parsed_schema
+      @options = options
+
+      @renderer = Renderer.new(@options)
+
+      @graphql_object_template = ERB.new(File.read(@options[:templates][:objects]))
+      @graphql_mutations_template = ERB.new(File.read(@options[:templates][:mutations]))
+      @graphql_interfaces_template = ERB.new(File.read(@options[:templates][:interfaces]))
+      @graphql_enums_template = ERB.new(File.read(@options[:templates][:enums]))
+      @graphql_unions_template = ERB.new(File.read(@options[:templates][:unions]))
+      @graphql_input_objects_template = ERB.new(File.read(@options[:templates][:input_objects]))
+      @graphql_scalars_template = ERB.new(File.read(@options[:templates][:scalars]))
+    end
+
+    def generate
+      FileUtils.rm_rf(@options[:output_dir])
+
+      create_graphql_object_pages
+      create_graphql_mutation_pages
+      create_graphql_interface_pages
+      create_graphql_enum_pages
+      create_graphql_union_pages
+      create_graphql_input_object_pages
+      create_graphql_scalar_pages
+
+      true
+    end
+
+    def create_graphql_object_pages
+      graphql_object_types.each do |object_type|
+        next if object_type['name'].start_with?('__')
+        opts = { type: object_type }.merge(helper_methods)
+        contents = @graphql_object_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('object', object_type['name'], contents)
+      end
+    end
+
+    def create_graphql_mutation_pages
+      graphql_mutation_types.each do |mutation|
+        input = graphql_input_object_types.find { |t| t['name'] = mutation['args'].first['type']['ofType']['name'] }
+        payload = graphql_object_types.find { |t| t['name'] == mutation['type']['name'] }
+
+        opts = { type: mutation, input_fields: input, return_fields: payload }.merge(helper_methods)
+
+        contents = @graphql_mutations_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('mutation', mutation['name'], contents)
+      end
+    end
+
+    def create_graphql_interface_pages
+      graphql_interface_types.each do |interface_type|
+        opts = { type: interface_type }.merge(helper_methods)
+
+        contents = @graphql_interfaces_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('interface', interface_type['name'], contents)
+      end
+    end
+
+    def create_graphql_enum_pages
+      graphql_enum_types.each do |enum_type|
+        opts = { type: enum_type }.merge(helper_methods)
+
+        contents = @graphql_enums_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('enum', enum_type['name'], contents)
+      end
+    end
+
+    def create_graphql_union_pages
+      graphql_union_types.each do |union_type|
+        opts = { type: union_type }.merge(helper_methods)
+
+        contents = @graphql_unions_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('union', union_type['name'], contents)
+      end
+    end
+
+    def create_graphql_input_object_pages
+      graphql_input_object_types.each do |input_object_type|
+        opts = { type: input_object_type }.merge(helper_methods)
+
+        contents = @graphql_input_objects_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('input_object', input_object_type['name'], contents)
+      end
+    end
+
+    def create_graphql_scalar_pages
+      graphql_scalar_types.each do |scalar_type|
+        opts = { type: scalar_type }.merge(helper_methods)
+
+        contents = @graphql_scalars_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('scalar', scalar_type['name'], contents)
+      end
+    end
+
+    private
+
+    def graphql_mutation_types
+      graphql_object_types.find { |t| t['name'] == 'Mutation' }['fields']
+    end
+
+    def graphql_object_types
+      @parsed_schema['object_types']
+    end
+
+    def graphql_interface_types
+      @parsed_schema['interface_types']
+    end
+
+    def graphql_enum_types
+      @parsed_schema['enum_types']
+    end
+
+    def graphql_union_types
+      @parsed_schema['union_types']
+    end
+
+    def graphql_input_object_types
+      @parsed_schema['input_object_types']
+    end
+
+    def graphql_scalar_types
+      @parsed_schema['scalar_types']
+    end
+
+    def write_file(type, name, contents)
+      path = File.join(@options[:output_dir], type, name.downcase)
+      FileUtils.mkdir_p(path)
+      contents = @renderer.render(contents)
+      File.write(File.join(path, 'index.html'), contents)
+    end
+  end
+end

data/lib/graphql-docs/generator/helpers.rb

@@ -0,0 +1,46 @@
+module GraphQLDocs
+  class Generator
+    module Helpers
+      SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
+
+      attr_accessor :templates
+
+      def slugify(str)
+        slug = str.gsub(SLUGIFY_PRETTY_REGEXP, '-')
+        slug.gsub!(%r!^\-|\-$!i, '')
+        slug.downcase
+      end
+
+      def include(filename, opts)
+        template = fetch_include(filename)
+        template.result(OpenStruct.new(opts.merge(helper_methods)).instance_eval { binding })
+      end
+
+      def fetch_include(filename)
+        @templates ||= {}
+
+        return @templates[filename] unless @templates[filename].nil?
+
+        @templates[filename] = ERB.new(File.read(File.join(@options[:templates][:includes], filename)))
+        @templates[filename]
+      end
+
+      def markdown(string)
+        GitHub::Markdown.render(string || 'n/a')
+      end
+
+      def helper_methods
+        return @helper_methods if defined?(@helper_methods)
+
+        @helper_methods = {}
+
+        Helpers.instance_methods.each do |name|
+          next if name == :helper_methods
+          @helper_methods[name] = method(name)
+        end
+
+        @helper_methods
+      end
+    end
+  end
+end

data/lib/graphql-docs/layouts/graphql_enums.html

@@ -0,0 +1,9 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+<% unless type['enumValues'].empty? %>
+
+<%= include.('values.html', values: type['enumValues']) %>
+
+<% end %>

data/lib/graphql-docs/layouts/graphql_input_objects.html

@@ -0,0 +1,9 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+<% unless type['inputFields'].nil? %>
+
+<%= include.('input_fields.html', input_fields: type['inputFields']) %>
+
+<% end %>

data/lib/graphql-docs/layouts/graphql_interfaces.html

@@ -0,0 +1,11 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+<% unless type['fields'].empty? %>
+
+### Fields
+
+<%= include.('fields.html', fields: type['fields']) %>
+
+<% end %>

data/lib/graphql-docs/layouts/graphql_mutations.html

@@ -0,0 +1,11 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+## Input fields
+
+<%= include.('/fields.html', fields: input_fields['inputFields']) %>
+
+## Return fields
+
+<%= include.('/fields.html', fields: return_fields['fields']) %>

data/lib/graphql-docs/layouts/graphql_objects.html

@@ -0,0 +1,31 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+<% unless type['interfaces'].empty? %>
+
+### Implements
+
+<ul>
+  <% type['interfaces'].each do |interface| %>
+    <li><code><a href="./interface/<%= slugify.(interface['name']) %>"><%= interface['name'] %></a></code></li>
+  <% end %>
+</ul>
+
+<% end %>
+
+<% unless type['connections'].empty? %>
+
+### Connections
+
+<%= include.('connections.html', connections: type['connections']) %>
+
+<% end %>
+
+<% unless type['fields'].empty? %>
+
+### Fields
+
+<%= include.('fields.html', fields: type['fields']) %>
+
+<% end %>

data/lib/graphql-docs/layouts/graphql_scalars.html

@@ -0,0 +1,3 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>

data/lib/graphql-docs/layouts/graphql_unions.html

@@ -0,0 +1,9 @@
+## <%= type['name'] %>
+
+<%= type['description'] %>
+
+<% unless type['possibleTypes'].empty? %>
+
+<%= include.('possible_types.html', possible_types: type['possibleTypes']) %>
+
+<% end %>

data/lib/graphql-docs/layouts/includes/arguments.html

@@ -0,0 +1,31 @@
+<table class="arguments" markdown="1">
+  <thead>
+    <tr>
+      <th>Argument</th>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% args.each do |argument| %>
+  <tr>
+    <td><code><%= argument['name'] %><code></td>
+    <td>
+
+      <% if argument['type']['name'] == "Non-Null" %>
+        <% @arg_path = argument['type']['ofType']['kind'] %>
+        <% @arg_name = argument['type']['ofType']['name'] %>
+      <% else %>
+        <% @arg_path = argument['type']['kind'] %>
+        <% @arg_name = argument['type']['name'] %>
+      <% end %>
+
+      <code><%= @arg_name %></code>
+    </td>
+    <td>
+      <p><%= markdown.(argument['description']) %></p>
+    </td>
+  </tr>
+  <% end %>
+  </tbody>
+</table>

data/lib/graphql-docs/layouts/includes/connections.html

@@ -0,0 +1,17 @@
+<% connections.each do |connection| %>
+
+<div class="field-entry my-4">
+  <span class="field-name connection-name"><%= connection['name'] %> (<a href="./object/<%= slugify.(connection['type']['ofType']['name']) %>" class="js-connection-name"><code><%= connection['type']['ofType']['name'] %></code></a>)</span>
+
+  <div class="description-wrapper">
+    <%= connection['description'] %>
+
+    <% unless connection['args'].empty? %>
+
+      <%= include.('arguments.html', args: connection['args']) %>
+
+    <% end %>
+  </div>
+</div>
+
+<% end %>

data/lib/graphql-docs/layouts/includes/fields.html

@@ -0,0 +1,47 @@
+<% fields.each do |field| %>
+
+<% next if field['type']['ofType'] && field['type']['ofType']['name'] && field['type']['ofType']['name'].end_with?('Connection') %>
+
+<div class="field-entry">
+  <% next if field['name'] == "id" || field['name'].blank? %>
+
+  <% if field['type']['ofType'] && !field['type']['ofType']['ofType'].nil? %>
+    <% if !field['type']['ofType']['ofType']['ofType'].nil? %>
+      <% @type_path = field['type']['ofType']['ofType']['ofType']['kind'] %>
+      <% @type_name = field['type']['ofType']['ofType']['ofType']['name'] %>
+    <% else %>
+      <% @type_path = field['type']['ofType']['ofType']['kind'] %>
+      <% @type_name = field['type']['ofType']['ofType']['name'] %>
+    <% end %>
+  <% elsif field['type']['ofType'].blank? %>
+    <% @type_path = field['type']['kind'] %>
+    <% @type_name = field['type']['name'] %>
+  <% elsif field['type']['name'] == "Non-Null" || field['type']['ofType']['name'] == "Non-Null" %>
+    <% @type_path = field['type']['ofType']['kind'] %>
+    <% @type_name = field['type']['ofType']['name'] %>
+  <% else %>
+    <% @type_path = field['type']['ofType']['kind'] %>
+    <% @type_name = field['type']['ofType']['name'] %>
+  <% end %>
+
+  <span class="field-name"><%= field['name'] %> (<code><a href="./<%= @type_path.downcase %>/<%= slugify.(@type_name) %>"><%= @type_name %></a></code>)</span>
+
+  <div class="description-wrapper">
+    <% if field['isDeprecated'] %>
+      <div class="deprecation-notice">
+        <span class="deprecation-title">Deprecation notice</span>
+        <%= markdown.(field['deprecationReason']) %>
+      </div>
+    <% end %>
+
+    <%= markdown.(field['description']) %>
+
+    <% unless field['args'].blank? %>
+
+      <%= include.('arguments.html', args: field['args']) %>
+
+    <% end %>
+  </div>
+</div>
+
+<% end %>

data/lib/graphql-docs/layouts/includes/input_fields.html

@@ -0,0 +1,42 @@
+### Input Fields
+
+<% input_fields.each do |field| %>
+
+<% next if field['type']['ofType'] && field['type']['ofType']['name'] && field['type']['ofType']['name'].end_with?('Connection') %>
+
+<div class="field-entry">
+  <% next if field['name'] == "id" || field['name'].blank? %>
+
+  <% if field['type']['ofType'] && !field['type']['ofType']['ofType'].nil? %>
+    <% if !field['type']['ofType']['ofType']['ofType'].nil? %>
+      <% @type_path = field['type']['ofType']['ofType']['ofType']['kind'] %>
+      <% @type_name = field['type']['ofType']['ofType']['ofType']['name'] %>
+    <% else %>
+      <% @type_path = field['type']['ofType']['ofType']['kind'] %>
+      <% @type_name = field['type']['ofType']['ofType']['name'] %>
+    <% end %>
+  <% elsif field['type']['ofType'].blank? %>
+    <% @type_path = field['type']['kind'] %>
+    <% @type_name = field['type']['name'] %>
+  <% elsif field['type']['name'] == "Non-Null" || field['type']['ofType']['name'] == "Non-Null" %>
+    <% @type_path = field['type']['ofType']['kind'] %>
+    <% @type_name = field['type']['ofType']['name'] %>
+  <% else %>
+    <% @type_path = field['type']['ofType']['kind'] %>
+    <% @type_name = field['type']['ofType']['name'] %>
+  <% end %>
+
+  <span class="field-name"><%= field['name'] %> (<a href="./<%= @type_path.downcase %>/slugify.(@type_name.parameterize)"><code><%= @type_name %></code></a>)</span>
+
+  <div class="description-wrapper">
+    <%= field['description'] %>
+
+    <% unless field['args'].nil? %>
+
+      <%= include.('arguments.html', args: field['args']) %>
+
+    <% end %>
+  </div>
+</div>
+
+<% end %>

data/lib/graphql-docs/layouts/includes/possible_types.html

@@ -0,0 +1,9 @@
+<h3 id="fields">Possible Types</h3>
+
+<ul>
+
+<% possible_types.each do |possible_type| %>
+  <li><a href="./<%= slugify.(possible_type['name']) %>"><%= possible_type['name'] %></a></li>
+<% end %>
+
+</ul>

data/lib/graphql-docs/layouts/includes/values.html

@@ -0,0 +1,11 @@
+<h3 id="fields">Values</h3>
+
+<% values.each do |value| %>
+
+  <h4 class="name"><%= value['name'] %></h4>
+
+  <div class="description-wrapper">
+    <%= value['description'] %>
+  </div>
+
+<% end %>

data/lib/graphql-docs/parser.rb

@@ -0,0 +1,41 @@
+module GraphQLDocs
+  class Parser
+    attr_reader :schema, :processed_schema
+
+    def initialize(response, options)
+      @options = options
+      @schema = JSON.parse(response)['data']
+      @processed_schema = @schema.dup['__schema']
+    end
+
+    def parse
+      # sort the types
+      @processed_schema['types'] = @processed_schema['types'].sort_by { |key, _| key['name'] }
+
+      # fetch the connections
+      @processed_schema['types'].each do |object|
+        next if object['fields'].nil?
+        object['connections'] = object['fields'].select { |f| next if f.is_a?(Array); connection?(f) }
+      end
+
+      # fetch the kinds of items
+      type_kinds = @processed_schema['types'].map { |h| h['kind'] }.uniq
+      type_kinds.each do |kind|
+        @processed_schema["#{kind.downcase}_types"] = @processed_schema['types'].select { |t| t['kind'] == kind }
+      end
+      # TODO: should the 'types' key be deleted now?
+
+      @processed_schema
+    end
+
+    private
+
+    def connection?(hash)
+      if hash['type']['ofType'] && hash['type']['ofType']['name'] && hash['type']['ofType']['name'].end_with?('Connection')
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/graphql-docs/renderer.rb

@@ -0,0 +1,46 @@
+require 'html/pipeline'
+require 'extended-markdown-filter'
+require 'page-toc-filter'
+
+module GraphQLDocs
+  class Renderer
+    def initialize(options)
+      @options = options
+
+      @pipeline_config = @options[:pipeline_config]
+
+      filters = @pipeline_config[:pipeline].map do |f|
+        if filter?(f)
+          f
+        else
+          key = filter_key(f)
+          filter = HTML::Pipeline.constants.find { |c| c.downcase == key }
+          # possibly a custom filter
+          if filter.nil?
+            Kernel.const_get(f)
+          else
+            HTML::Pipeline.const_get(filter)
+          end
+        end
+      end
+
+      @pipeline = HTML::Pipeline.new(filters, @pipeline_config[:context])
+    end
+
+    def render(string)
+      @pipeline.to_html(string)
+    end
+
+    private
+
+    def filter_key(s)
+      s.downcase
+    end
+
+    def filter?(f)
+      f < HTML::Pipeline::Filter
+    rescue LoadError, ArgumentError
+      false
+    end
+  end
+end

data/lib/graphql-docs/version.rb

@@ -0,0 +1,3 @@
+module GraphQLDocs
+  VERSION = '0.1.0'
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+bundle install "$@"

data/script/console

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+
+dir=`pwd`
+
+echo "===> Bundling..."
+script/bootstrap --quiet
+
+echo "===> Launching..."
+bundle exec rake console

metadata

@@ -0,0 +1,285 @@
+--- !ruby/object:Gem::Specification
+name: graphql-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+- !ruby/object:Gem::Dependency
+  name: extended-markdown-filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: page-toc-filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !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: rubocop-github
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- graphql-docs.gemspec
+- lib/graphql-docs.rb
+- lib/graphql-docs/client.rb
+- lib/graphql-docs/configuration.rb
+- lib/graphql-docs/generator.rb
+- lib/graphql-docs/generator/helpers.rb
+- lib/graphql-docs/layouts/graphql_enums.html
+- lib/graphql-docs/layouts/graphql_input_objects.html
+- lib/graphql-docs/layouts/graphql_interfaces.html
+- lib/graphql-docs/layouts/graphql_mutations.html
+- lib/graphql-docs/layouts/graphql_objects.html
+- lib/graphql-docs/layouts/graphql_scalars.html
+- lib/graphql-docs/layouts/graphql_unions.html
+- lib/graphql-docs/layouts/includes/arguments.html
+- lib/graphql-docs/layouts/includes/connections.html
+- lib/graphql-docs/layouts/includes/fields.html
+- lib/graphql-docs/layouts/includes/input_fields.html
+- lib/graphql-docs/layouts/includes/possible_types.html
+- lib/graphql-docs/layouts/includes/values.html
+- lib/graphql-docs/parser.rb
+- lib/graphql-docs/renderer.rb
+- lib/graphql-docs/version.rb
+- script/bootstrap
+- script/console
+homepage: https://github.com/gjtorikian/graphql-docs
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Easily generate beautiful documentation from your GraphQL schema.
+test_files: []