graphql-docs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 540afb95d491f00898705c8bd73fdb8a31d685c9
-  data.tar.gz: 23b419944ad81f60fff9264e3691d604ffeda467
+  metadata.gz: aaa1474842e99247ca5ed73d7bb1fb4eaf1ed3cf
+  data.tar.gz: 78c24d6cfe911f4990cf5453650aab0ea3b00026
 SHA512:
-  metadata.gz: 6ee639a760366f5f240dc117d5770045700e1676eaf9abb06041009513e0a31470a3c6bd77eaf1da4642e542fdc35e2669f9ee22dff23da6ee8c2aa6ee74edf5
-  data.tar.gz: 78561641aae9442b65c565b1f198f0dc9da933bfbefc8ad1f6ad50b3d553d4670fcebf3c3d094fb5ecc18779cd2fa7b043a572fe7b1c1d4181302a8fc6e2bddb
+  metadata.gz: b814f147f59e77c4a912741a66f494b033825c82c7206f8d5869ac31f38a0d5c910c93bd41ce95e6e22acaac2bbc7d8340a5eef745177079e9a97f82ec2410b9
+  data.tar.gz: 68d4bd88d2cb35d7ae765da04abab98273036e02f60faf68794673205f10409eb32836de653c4b9088f5f3accb40fd0612a6498207d4d7962eb217c05b89ee02

data/.gitignore

@@ -10,4 +10,4 @@
 /output/
 /test/graphql-docs/fixtures/output/
 /.sass-cache/
-/sample/
+/output/

data/README.md

@@ -2,6 +2,8 @@
 
 Easily generate beautiful documentation from your GraphQL schema.
 
+![sample](https://cloud.githubusercontent.com/assets/64050/23438604/6a23add0-fdc7-11e6-8852-ef41e8451033.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,22 +25,22 @@ Or install it yourself as:
 Simple! Call `GraphQLDocs.generate`, taking care to pass in the GraphQL endpoint:
 
 ``` ruby
-GraphQLDocs.build(url: "http://graphql.org/swapi-graphql/")
+GraphQLDocs.build(url: 'http://graphql.org/swapi-graphql/')
 ```
 
 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"
+  url: 'http://graphql.org/swapi-graphql/'
+  login: 'gjtorikian',
+  password: 'lolnowai'
 }
 GraphQLDocs.build(options)
 
 options = {
-  url: "http://graphql.org/swapi-graphql/"
-  access_token: "something123"
+  url: 'http://graphql.org/swapi-graphql/'
+  access_token: 'something123'
 }
 
 GraphQLDocs.build(options)
@@ -52,12 +54,12 @@ GraphQLDocs.build(path: 'location/to/sw-api.json')
 
 ## Breakdown
 
-There are several phaseses going on in one little `GraphQLDocs.build` call:
+There are several 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.
-* `GraphQL::Parser` technically runs as part of the generation phase. It passes the contents of each page through a Markdown renderer.
+* `GraphQL::Renderer` technically runs as part of the generation phase. It passes the contents of each page through a Markdown renderer.
 
 If you wanted to, you could break these calls up individually. For example:
 
@@ -110,14 +112,14 @@ In your ERB layouts, there are several helper methods you can use. The helper me
 * `slugify(str)` - This slugifies the given string.
 * `include(filename, opts)` - This embeds a template from your `includes` folder, passing along the local options provided.
 * `markdown(string)` - This converts a string from Markdown to HTML.
+* `graphql_mutation_types`, `graphql_object_types`, `graphql_interface_types`, `graphql_enum_types`, `graphql_union_types`, `graphql_input_object_types`, `graphql_scalar_types` - Collections of the various GraphQL types.
 
-To call these methods, you must use the dot notation, such as `<%= slugify.(text) %>`.
+To call these methods within templates, you must use the dot notation, such as `<%= slugify.(text) %>`.
 
 ## Configuration
 
 The following options are available:
 
-
 | Option | Description | Default |
 | :----- | :---------- | :------ |
 | `access_token` | Uses this token while making requests through `GraphQLDocs::Client`. | `nil` |
@@ -126,14 +128,16 @@ The following options are available:
 | `path` | `GraphQLDocs::Client` loads a JSON file found at this location, representing the response from an introspection query. | `nil` |
 | `url` | `GraphQLDocs::Client` makes a `POST` request to this URL, passing along the introspection query. | `nil` |
 | `output_dir` | The location of the output HTML. | `./output/` |
+| `use_default_styles` | Indicates if you want to use the default styles. | `true` |
+| `base_url` | Indicates the base URL to prepend for assets and links. | `true` |
 | `delete_output` | Deletes `output_dir` before generating content. | `false` |
 | `pipeline_config` | Defines two sub-keys, `pipeline` and `context`, which are used by `html-pipeline` when rendering your output. | `pipeline` has `ExtendedMarkdownFilter`, `EmojiFilter`, and `TableOfContentsFilter`. `context` has `gfm: false` and `asset_root` set to GitHub's CDN. |
 | `renderer` | The rendering class to use. | `GraphQLDocs::Renderer`
-| `templates` | The templates to use when generating HTML. You may override any of the following keys: `includes`, `objects`, `mutations`, `interfaces`, `enums`, `unions`, `input_objects`, `scalars`. | The default gem ones are found in _layouts/_.
+| `templates` | The templates to use when generating HTML. You may override any of the following keys: `includes`, `objects`, `mutations`, `interfaces`, `enums`, `unions`, `input_objects`, `scalars`, `index`. | The defaults are found in _lib/graphql-docs/layouts/_.
 
 ## 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.
+After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle exec rake console` for an interactive prompt that will allow you to experiment.
 
 ## Sample site
 

data/Rakefile

@@ -22,30 +22,41 @@ task :console do
   Pry.start
 end
 
-task :sample do
+task :generate_sample, [:base_url] do |task, args|
   require 'graphql-docs'
-  require 'sass'
 
   options = {}
-  options[:output_dir] = 'sample'
   options[:delete_output] = true
+  options[:base_url] = args.base_url || ''
   options[:path] = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-api.json')
 
   GraphQLDocs.build(options)
+end
 
-  assets_dir = File.join('sample', 'assets')
-  FileUtils.mkdir_p(assets_dir)
-
-  sass = File.join('sample_assets', 'css', 'screen.scss')
-  system `sass --sourcemap=none #{sass}:style.css`
+task :sample => [:generate_sample] do
+  require 'webrick'
 
-  FileUtils.mv('style.css', File.join('sample', 'assets/style.css'))
+  puts 'Navigate to http://localhost:3000 to see the sample docs'
 
-  starting_dir = 'sample'
-  starting_file = File.join(starting_dir, 'object', 'repository', 'index.html')
+  server = WEBrick::HTTPServer.new Port: 3000
+  server.mount '/', WEBrick::HTTPServlet::FileHandler, 'output'
+  trap('INT') { server.stop }
+  server.start
+end
 
-  puts 'Navigate to http://localhost:3000 to see the sample docs'
-  puts "Launching #{starting_file}"
-  system "open #{starting_file}"
-  system "ruby -run -e httpd #{starting_dir} -p 3000"
+desc 'Generate and publish docs to gh-pages'
+task :publish do
+  Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs/')
+  Dir.mktmpdir do |tmp|
+    system "mv output/* #{tmp}"
+    system 'git checkout gh-pages'
+    system 'rm -rf *'
+    system "mv #{tmp}/* ."
+    message = "Site updated at #{Time.now.utc}"
+    system 'git add .'
+    system "git commit -am #{message.shellescape}"
+    system 'git push origin gh-pages --force'
+    system 'git checkout master'
+    system 'echo yolo'
+  end
 end

data/graphql-docs.gemspec

@@ -28,14 +28,15 @@ Gem::Specification.new do |spec|
   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 'sass', '~> 3.4'
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'html-proofer', '~> 3.4'
   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 'sass', '~> 3.4'
   spec.add_development_dependency 'webmock', '~> 2.3'
 end

data/lib/graphql-docs/client.rb

@@ -30,10 +30,11 @@ module GraphQLDocs
     end
 
     def fetch
-      @faraday.post do |req|
+      res = @faraday.post do |req|
         req.headers['Content-Type'] = 'application/json'
         req.body = "{ \"query\": \"#{GraphQL::Introspection::INTROSPECTION_QUERY.gsub("\n", '')}\" }"
       end
+      res.body
     end
 
     def inspect

data/lib/graphql-docs/configuration.rb

@@ -22,9 +22,12 @@ module GraphQLDocs
         }
       },
       renderer: GraphQLDocs::Renderer,
+      use_default_styles: true,
+      base_url: '',
 
       templates: {
         default: "#{File.dirname(__FILE__)}/layouts/default.html",
+
         includes: "#{File.dirname(__FILE__)}/layouts/includes",
         objects: "#{File.dirname(__FILE__)}/layouts/graphql_objects.html",
         mutations: "#{File.dirname(__FILE__)}/layouts/graphql_mutations.html",
@@ -32,7 +35,9 @@ module GraphQLDocs
         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"
+        scalars: "#{File.dirname(__FILE__)}/layouts/graphql_scalars.html",
+
+        index: "#{File.dirname(__FILE__)}/layouts/index.md",
       }
     }.freeze
   end

data/lib/graphql-docs/generator.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'sass'
 
 module GraphQLDocs
   class Generator
@@ -32,6 +33,21 @@ module GraphQLDocs
       create_graphql_input_object_pages
       create_graphql_scalar_pages
 
+      unless @options[:templates][:index].nil?
+        write_file('static', 'index', File.read(@options[:templates][:index]))
+      end
+
+      if @options[:use_default_styles]
+        assets_dir = File.join(File.dirname(__FILE__), 'layouts', 'assets')
+        FileUtils.mkdir_p(File.join(@options[:output_dir], 'assets'))
+
+        sass = File.join(assets_dir, 'css', 'screen.scss')
+        system `sass --sourcemap=none #{sass}:#{@options[:output_dir]}/assets/style.css`
+
+        FileUtils.cp_r(File.join(assets_dir, 'images'), File.join(@options[:output_dir], 'assets'))
+        FileUtils.cp_r(File.join(assets_dir, 'webfonts'), File.join(@options[:output_dir], 'assets'))
+      end
+
       true
     end
 
@@ -106,8 +122,16 @@ module GraphQLDocs
     private
 
     def write_file(type, name, contents)
-      path = File.join(@options[:output_dir], type, name.downcase)
-      FileUtils.mkdir_p(path)
+      if type == 'static'
+        if name == 'index'
+          path = @options[:output_dir]
+        else
+          path = File.join(@options[:output_dir], name)
+        end
+      else
+        path = File.join(@options[:output_dir], type, name.downcase)
+        FileUtils.mkdir_p(path)
+      end
       contents = @renderer.render(type, name, contents)
       File.write(File.join(path, 'index.html'), contents) unless contents.nil?
     end

data/lib/graphql-docs/layouts/assets/_sass/_fonts.scss

@@ -0,0 +1,21 @@
+@import "//hello.myfonts.net/count/2c4b9d";
+@font-face {
+  font-family: 'ProximaNova-Light';
+  src: url("webfonts/2C4B9D_B_0.eot");
+  src: url("webfonts/2C4B9D_B_0.eot?#iefix") format('embedded-opentype'), url("webfonts/2C4B9D_B_0.woff2") format('woff2'), url("webfonts/2C4B9D_B_0.woff") format('woff'), url("webfonts/2C4B9D_B_0.ttf") format('truetype');
+}
+@font-face {
+  font-family: 'ProximaNova-Semibold';
+  src: url("webfonts/2C4B9D_C_0.eot");
+  src: url("webfonts/2C4B9D_C_0.eot?#iefix") format('embedded-opentype'), url("webfonts/2C4B9D_C_0.woff2") format('woff2'), url("webfonts/2C4B9D_C_0.woff") format('woff'), url("webfonts/2C4B9D_C_0.ttf") format('truetype');
+}
+@font-face {
+  font-family: 'ProximaNova-Regular';
+  src: url("webfonts/2C4B9D_D_0.eot");
+  src: url("webfonts/2C4B9D_D_0.eot?#iefix") format('embedded-opentype'), url("webfonts/2C4B9D_D_0.woff2") format('woff2'), url("webfonts/2C4B9D_D_0.woff") format('woff'), url("webfonts/2C4B9D_D_0.ttf") format('truetype');
+}
+@font-face {
+  font-family: 'ProximaNova-Bold';
+  src: url("webfonts/2C4B9D_E_0.eot");
+  src: url("webfonts/2C4B9D_E_0.eot?#iefix") format('embedded-opentype'), url("webfonts/2C4B9D_E_0.woff2") format('woff2'), url("webfonts/2C4B9D_E_0.woff") format('woff'), url("webfonts/2C4B9D_E_0.ttf") format('truetype');
+}

data/{sample_assets → lib/graphql-docs/layouts/assets}/_sass/_mobile.scss

@@ -14,7 +14,7 @@
     height: 24px;
     top: 8px;
     left: 12px;
-    background: url("../images/menu.png") center center no-repeat;
+    background: url("../assets/images/menu.png") center center no-repeat;
     background-size: 24px;
     opacity: 0.5;
   }

data/{sample_assets → lib/graphql-docs/layouts/assets}/_sass/_search.scss

@@ -8,7 +8,7 @@
     padding: 7px 12px 6px 32px;
     border-radius: 20px;
     border: 1px solid #ddd;
-    background: url("../images/search.png") 8px 6px no-repeat;
+    background: url("../assets/images/search.png") 8px 6px no-repeat;
     background-size: 20px;
     transition: border-color 0.25s ease;
     &:focus {
@@ -25,7 +25,7 @@
   padding: 7px 12px 6px 32px;
   border-radius: 20px;
   border: 1px solid #ddd;
-  background: url("../images/search.png") 8px 6px no-repeat;
+  background: url("../assets/images/search.png") 8px 6px no-repeat;
   background-size: 20px;
   transition: border-color 0.25s ease;
   &:focus {

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

@@ -5,9 +5,21 @@
     <meta name="description" content="<%= name %> GraphQL documentation">
     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
     <title><%= name %></title>
-    <link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,300,200,300italic,400italic' rel='stylesheet' type='text/css'>
-    <link rel="stylesheet" href="../../assets/style.css">
-    <script src="https://code.jquery.com/jquery-3.0.0.min.js" integrity="sha256-JmvOoLtYsmqlsWxa7mDSLMwa6dZ9rrIdtrrVYRnDRH0=" crossorigin="anonymous"></script>
+    <link rel="stylesheet" href="<%= base_url %>/assets/style.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.2/anchor.min.js"></script>
+    <script>
+
+    // Add anchors on DOMContentLoaded
+    document.addEventListener("DOMContentLoaded", function(event) {
+      anchors.options = {
+        placement: 'left',
+        visible: 'hover',
+        icon: '¶'
+      };
+      anchors.add('h3');
+    });
+
+    </script>
   </head>
   <body>
 
@@ -19,8 +31,6 @@
       </div>
       <div id="content">
 
-        <h1><%= name %></h1>
-
         <%= contents %>
 
       </div>
@@ -35,5 +45,6 @@
       <div id="mobile-shade"></div>
 
     </div>
+
   </body>
 </html>

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

@@ -8,7 +8,7 @@
 
 <ul>
   <% type['interfaces'].each do |interface| %>
-    <li><code><a href="./interface/<%= slugify.(interface['name']) %>"><%= interface['name'] %></a></code></li>
+    <li><code><a href="<%= base_url %>/interface/<%= slugify.(interface['name']) %>"><%= interface['name'] %></a></code></li>
   <% end %>
 </ul>
 

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

@@ -1,7 +1,7 @@
 <% 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>
+  <span class="field-name connection-name"><%= connection['name'] %> (<a href="<%= base_url %>/object/<%= slugify.(connection['type']['ofType']['name']) %>" class="js-connection-name"><code><%= connection['type']['ofType']['name'] %></code></a>)</span>
 
   <div class="description-wrapper">
     <%= connection['description'] %>

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

@@ -24,7 +24,7 @@
     <% @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>
+  <span class="field-name"><%= field['name'] %> (<code><a href="<%= base_url %>/<%= @type_path.downcase %>/<%= slugify.(@type_name) %>"><%= @type_name %></a></code>)</span>
 
   <div class="description-wrapper">
     <% if field['isDeprecated'] %>

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

@@ -26,7 +26,7 @@
     <% @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>
+  <span class="field-name"><%= field['name'] %> (<a href="<%= base_url %>/<%= @type_path.downcase %>/<%= slugify.(@type_name) %>"><code><%= @type_name %></code></a>)</span>
 
   <div class="description-wrapper">
     <%= field['description'] %>

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

@@ -3,7 +3,7 @@
 <ul>
 
 <% possible_types.each do |possible_type| %>
-  <li><a href="./<%= slugify.(possible_type['name']) %>"><%= possible_type['name'] %></a></li>
+  <li><a href="<%= base_url %>/object/<%= slugify.(possible_type['name']) %>"><%= possible_type['name'] %></a></li>
 <% end %>
 
 </ul>

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

@@ -2,7 +2,7 @@
   <li>
     <ul class="menu-root">
       <li>
-        GraphQL Reference
+        <a href="/">GraphQL Reference</a>
     </ul>
   </li>
 
@@ -10,12 +10,12 @@
     <p>Queries</p>
     <ul class="menu-root">
       <li>
-        <a href="../../object/query" class="sidebar-link<% if title == "Query" %> current<% end %>">
+        <a href="<%= base_url %>/object/query/" class="sidebar-link<% if title == "Query" %> current<% end %>">
           RootQuery
         </a>
       </li>
       <li>
-        <a href="../../object/mutation" class="sidebar-link<% if title == "Mutation" %> current<% end %>">
+        <a href="<%= base_url %>/object/mutation" class="sidebar-link<% if title == "Mutation" %> current<% end %>">
           Mutation
         </a>
       </li>
@@ -43,7 +43,7 @@
         <% end %>
 
       <li>
-        <a href="../../object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>
@@ -57,7 +57,7 @@
       <% graphql_interface_types.().each do |type| %>
         <% @name = type["name"] %>
         <li>
-          <a href="../../interface/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+          <a href="<%= base_url %>/interface/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
             <%= @name %>
           </a>
         </li>
@@ -75,7 +75,7 @@
         <% next %>
       <% end %>
       <li>
-        <a href="../../enum/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/enum/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>
@@ -89,7 +89,7 @@
       <% graphql_union_types.().each do |type| %>
       <% @name = type["name"] %>
       <li>
-        <a href="../../union/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/union/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>
@@ -103,7 +103,7 @@
       <% graphql_input_object_types.().each do |type| %>
       <% @name = type["name"] %>
       <li>
-        <a href="../../input_object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/input_object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>
@@ -117,7 +117,7 @@
       <% graphql_scalar_types.().each do |type| %>
       <% @name = type["name"] %>
       <li>
-        <a href="../../scalar/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/scalar/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>

data/lib/graphql-docs/layouts/index.md

@@ -0,0 +1,7 @@
+# GraphQL Reference
+
+These docs were generated by [graphql-docs](https://github.com/gjtorikian/graphql-docs).
+
+## New to GraphQL?
+
+Just starting out with GraphQL? Check out GraphQL's [official documentation](http://graphql.org/)!

data/lib/graphql-docs/parser.rb

@@ -23,9 +23,16 @@ module GraphQLDocs
       type_kinds.each do |kind|
         @processed_schema["#{kind.downcase}_types"] = @processed_schema['types'].select { |t| t['kind'] == kind }
       end
-      @processed_schema['mutation_types'] = @processed_schema['object_types'].select do |t|
+      mutation_types = @processed_schema['object_types'].select do |t|
         t['name'] == 'Mutation'
-      end.first['fields']
+      end
+
+      @processed_schema['mutation_types'] = if mutation_types.empty?
+                                              []
+                                            else
+                                              @processed_schema['mutation_types'] = mutation_types.first['fields']
+                                            end
+
       # TODO: should the 'types' key be deleted now?
 
       @processed_schema

data/lib/graphql-docs/renderer.rb

@@ -36,7 +36,8 @@ module GraphQLDocs
     def render(type, name, contents)
       contents = @pipeline.to_html(contents)
       return contents if @graphql_default_layout.nil?
-      opts = { contents: contents, type: type, name: name}.merge(helper_methods)
+      opts = @options
+      opts = opts.merge({ contents: contents, type: type, name: name}).merge(helper_methods)
       @graphql_default_layout.result(OpenStruct.new(opts).instance_eval { binding })
     end
 

data/lib/graphql-docs/version.rb

@@ -1,3 +1,3 @@
 module GraphQLDocs
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -192,20 +220,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sass
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +254,39 @@ files:
 - lib/graphql-docs/configuration.rb
 - lib/graphql-docs/generator.rb
 - lib/graphql-docs/helpers.rb
+- lib/graphql-docs/layouts/assets/_sass/_api-box.scss
+- lib/graphql-docs/layouts/assets/_sass/_content.scss
+- lib/graphql-docs/layouts/assets/_sass/_fonts.scss
+- lib/graphql-docs/layouts/assets/_sass/_header.scss
+- lib/graphql-docs/layouts/assets/_sass/_mobile.scss
+- lib/graphql-docs/layouts/assets/_sass/_normalize.scss
+- lib/graphql-docs/layouts/assets/_sass/_search.scss
+- lib/graphql-docs/layouts/assets/_sass/_sidebar.scss
+- lib/graphql-docs/layouts/assets/_sass/_syntax.scss
+- lib/graphql-docs/layouts/assets/_sass/_types.scss
+- lib/graphql-docs/layouts/assets/_sass/screen.scss
+- lib/graphql-docs/layouts/assets/css/screen.scss
+- lib/graphql-docs/layouts/assets/images/graphiql-headers.png
+- lib/graphql-docs/layouts/assets/images/graphiql-variables.png
+- lib/graphql-docs/layouts/assets/images/graphiql.png
+- lib/graphql-docs/layouts/assets/images/menu.png
+- lib/graphql-docs/layouts/assets/images/navbar.png
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.eot
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.ttf
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.woff
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.woff2
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.eot
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.ttf
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.woff
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.woff2
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.eot
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.ttf
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.woff
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.woff2
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.eot
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.ttf
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.woff
+- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.woff2
 - lib/graphql-docs/layouts/default.html
 - lib/graphql-docs/layouts/graphql_enums.html
 - lib/graphql-docs/layouts/graphql_input_objects.html
@@ -255,21 +302,10 @@ files:
 - lib/graphql-docs/layouts/includes/possible_types.html
 - lib/graphql-docs/layouts/includes/sidebar.html
 - lib/graphql-docs/layouts/includes/values.html
+- lib/graphql-docs/layouts/index.md
 - lib/graphql-docs/parser.rb
 - lib/graphql-docs/renderer.rb
 - lib/graphql-docs/version.rb
-- sample_assets/_sass/_api-box.scss
-- sample_assets/_sass/_content.scss
-- sample_assets/_sass/_fonts.scss
-- sample_assets/_sass/_header.scss
-- sample_assets/_sass/_mobile.scss
-- sample_assets/_sass/_normalize.scss
-- sample_assets/_sass/_search.scss
-- sample_assets/_sass/_sidebar.scss
-- sample_assets/_sass/_syntax.scss
-- sample_assets/_sass/_types.scss
-- sample_assets/_sass/screen.scss
-- sample_assets/css/screen.scss
 - script/bootstrap
 - script/console
 homepage: https://github.com/gjtorikian/graphql-docs

data/sample_assets/_sass/_fonts.scss

@@ -1,21 +0,0 @@
-@import "//hello.myfonts.net/count/2c4b9d";
-@font-face {
-  font-family: 'ProximaNova-Light';
-  src: url("/assets/webfonts/2C4B9D_B_0.eot");
-  src: url("/assets/webfonts/2C4B9D_B_0.eot?#iefix") format('embedded-opentype'), url("/assets/webfonts/2C4B9D_B_0.woff2") format('woff2'), url("/assets/webfonts/2C4B9D_B_0.woff") format('woff'), url("/assets/webfonts/2C4B9D_B_0.ttf") format('truetype');
-}
-@font-face {
-  font-family: 'ProximaNova-Semibold';
-  src: url("/assets/webfonts/2C4B9D_C_0.eot");
-  src: url("/assets/webfonts/2C4B9D_C_0.eot?#iefix") format('embedded-opentype'), url("/assets/webfonts/2C4B9D_C_0.woff2") format('woff2'), url("/assets/webfonts/2C4B9D_C_0.woff") format('woff'), url("/assets/webfonts/2C4B9D_C_0.ttf") format('truetype');
-}
-@font-face {
-  font-family: 'ProximaNova-Regular';
-  src: url("/assets/webfonts/2C4B9D_D_0.eot");
-  src: url("/assets/webfonts/2C4B9D_D_0.eot?#iefix") format('embedded-opentype'), url("/assets/webfonts/2C4B9D_D_0.woff2") format('woff2'), url("/assets/webfonts/2C4B9D_D_0.woff") format('woff'), url("/assets/webfonts/2C4B9D_D_0.ttf") format('truetype');
-}
-@font-face {
-  font-family: 'ProximaNova-Bold';
-  src: url("/assets/webfonts/2C4B9D_E_0.eot");
-  src: url("/assets/webfonts/2C4B9D_E_0.eot?#iefix") format('embedded-opentype'), url("/assets/webfonts/2C4B9D_E_0.woff2") format('woff2'), url("/assets/webfonts/2C4B9D_E_0.woff") format('woff'), url("/assets/webfonts/2C4B9D_E_0.ttf") format('truetype');
-}