graphql-docs 0.6.2 → 1.0.0.pre

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

@@ -137,6 +137,13 @@
   }
   table {
     margin-top: 10px;
+    th {
+      text-align: left;
+      padding: 0 25px 0 25px;
+    }
+    thead th:first-child {
+      padding: 0;
+    }
     td p {
       padding: 0 25px 0 25px;
     }
@@ -456,6 +463,7 @@
       padding: 12px 13px;
       border: 1px solid #eee;
       vertical-align: middle;
+      text-align: left;
     }
     td {
       border: 1px solid #eee;
@@ -494,4 +502,18 @@
       }
     }
   }
+
+  .field-name {
+    font-weight: bold;
+  }
+
+  .field-entry {
+    margin-bottom: 4rem;
+  }
+  .description-wrapper {
+    >p {
+      padding-left: 1rem;
+      margin-bottom: 1rem;
+    }
+  }
 }

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

@@ -0,0 +1,9 @@
+.deprecation-notice {
+  padding-left: 5px;
+  border-left: 2px solid #e8400d;
+  background: #fdf2ec;
+
+  span {
+    font-weight: bold;
+  }
+}

data/lib/graphql-docs/layouts/assets/css/screen.scss

@@ -46,3 +46,4 @@ em {
 @import '../_sass/_mobile';
 @import '../_sass/_api-box';
 @import '../_sass/_syntax';
+@import '../_sass/_deprecations';

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

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

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

@@ -1,11 +1,11 @@
-# <%= type['name'] %>
+<h1><%= type[:name] %></h1>
 
-<%= type['description'] %>
+<%= type[:description] %>
 
-<% unless type['inputFields'].nil? %>
+<% unless type[:inputFields].nil? %>
 
-## Input Fields
+<h2>Input Fields</h2>
 
-<%= include.('input_fields.html', input_fields: type['inputFields']) %>
+<%= include.('input_fields.html', input_fields: type[:input_fields]) %>
 
 <% end %>

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

@@ -1,11 +1,23 @@
-# <%= type['name'] %>
+<h1><%= type[:name] %></h1>
 
-<%= type['description'] %>
+<%= type[:description] %>
 
-<% unless type['fields'].empty? %>
+<% unless type[:implemented_by].empty? %>
 
-## Fields
+<h2>Implemented by</h2>
 
-<%= include.('fields.html', fields: type['fields']) %>
+<ul>
+  <% type[:implemented_by].each do |implementor| %>
+    <li><code><a href="<%= base_url %>/object/<%= slugify.(implementor) %>"><%= implementor %></a></code></li>
+  <% end %>
+</ul>
+
+<% end %>
+
+<% unless type[:fields].empty? %>
+
+<h2>Fields</h2>
+
+<%= include.('fields.html', fields: type[:fields]) %>
 
 <% end %>

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

@@ -1,11 +1,19 @@
-# <%= type['name'] %>
+<h1><%= type[:name] %></h1>
 
-<%= type['description'] %>
+<%= type[:description] %>
 
-## Input fields
+<h2>Input fields</h2>
 
-<%= include.('/fields.html', fields: input_fields['inputFields']) %>
+<% if !type[:input_fields].empty? %>
+  <%= include.('/fields.html', fields: type[:input_fields]) %>
+<% else %>
+  <p>None</p>
+<% end %>
 
-## Return fields
+<h2>Return fields</h2>
 
-<%= include.('/fields.html', fields: return_fields['fields']) %>
+<% if !type[:return_fields].empty? %>
+  <%= include.('/fields.html', fields: type[:return_fields]) %>
+<% else %>
+  <p>None</p>
+<% end %>

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

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

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

@@ -0,0 +1,19 @@
+<h1><%= type[:name] %></h1>
+
+<%= type[:description] %>
+
+<% unless type[:connections].empty? %>
+
+<h2>Connections</h2>
+
+<%= include.('connections.html', connections: type[:connections]) %>
+
+<% end %>
+
+<% unless type[:fields].empty? %>
+
+<h2>Fields</h2>
+
+<%= include.('fields.html', fields: type[:fields]) %>
+
+<% end %>

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

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

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

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

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

@@ -9,15 +9,12 @@
   <tbody>
   <% args.each do |argument| %>
   <tr>
-    <td><code><%= argument['name'] %></code></td>
+    <td><code><%= argument[:name] %></code></td>
     <td>
-
-      <% @type_path, @type_name, @name_slug = format_type.(argument) %>
-
-      <code><a href="<%= base_url %>/<%= @type_path %>/<%= @name_slug %>"><%= @type_name %></a></code>
+      <code><a href="<%= base_url %>/<%= argument[:type][:path]%>"><%= argument[:type][:info] %></a></code>
     </td>
     <td>
-      <p><%= markdown.(argument['description']) %></p>
+      <p><%= markdown.(argument[:description]) %></p>
     </td>
   </tr>
   <% end %>

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

@@ -1,14 +1,14 @@
 <% connections.each do |connection| %>
 
 <div class="field-entry <%= classes[:field_entry] %>">
-  <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>
+  <span class="field-name connection-name"><%= connection[:name] %> (<a href="<%= base_url %>/<%= connection[:type][:path] %>" class="js-connection-name"><code><%= connection[:type][:info] %></code></a>)</span>
 
   <div class="description-wrapper">
-    <%= connection['description'] %>
+    <p><%= connection[:description] %></p>
 
-    <% unless connection['args'].empty? %>
+    <% unless connection[:arguments].empty? %>
 
-      <%= include.('arguments.html', args: connection['args']) %>
+      <%= include.('arguments.html', args: connection[:arguments]) %>
 
     <% end %>
   </div>

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

@@ -1,29 +1,25 @@
 <% fields.each do |field| %>
 
-<% next if field['type']['ofType'] && field['type']['ofType']['name'] && field['type']['ofType']['name'].end_with?('Connection') %>
-
 <div class="field-entry <%= classes[:field_entry] %>">
-  <% next if field['name'] == "id" || field['name'].blank? %>
-
-  <% @type_path, @type_name, @name_slug = format_type.(field) %>
+  <% next if field[:name] == "id" || field[:name].blank? %>
 
-  <span class="field-name"><%= field['name'] %> (<code><a href="<%= base_url %>/<%= @type_path %>/<%= @name_slug %>"><%= @type_name %></a></code>)</span>
+  <span class="field-name"><%= field[:name] %> (<code><a href="<%= base_url %>/<%= field[:type][:path] %>"><%= field[:type][:info] %></a></code>)</span>
 
   <div class="description-wrapper">
-    <% if field['isDeprecated'] %>
-      <div class="deprecation-notice <%= classes[: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 %>
+  <% if field[:is_deprecated] %>
+    <div class="deprecation-notice <%= classes[:deprecation_notice] %>">
+      <span class="deprecation-title">Deprecation notice</span>
+      <%= markdown.(field[:deprecation_reason]) %>
+    </div>
+  <% end %>
+
+  <% if field[:description].present? %>
+    <%= markdown.(field[:description].strip) %>
+  <% end %>
+
+  <% unless field[:arguments].blank? %>
+    <%= include.('arguments.html', args: field[:arguments]) %>
+  <% end %>
   </div>
 </div>
 

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

@@ -1,20 +1,16 @@
 <% 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 <%= classes[:field_entry] %>">
-  <% next if field['name'] == "id" || field['name'].blank? %>
-
-  <% @type_path, @type_name, @name_slug = format_type.(field) %>
+  <% next if field[:name] == "id" || field[:name].blank? %>
 
-  <span class="field-name"><%= field['name'] %> (<a href="<%= base_url %>/<%= @type_path %>/<%= @name_slug %>"><code><%= @type_name %></code></a>)</span>
+  <span class="field-name"><%= field[:name] %> (<a href="<%= base_url %>/<%= field[:type][:path] %>"><code><%= field[:type][:info] %></code></a>)</span>
 
   <div class="description-wrapper">
-    <%= field['description'] %>
+    <p><%= field[:description] %></p>
 
-    <% unless field['args'].nil? %>
+    <% unless field[:args].nil? %>
 
-      <%= include.('arguments.html', args: field['args']) %>
+      <%= include.('arguments.html', args: field[:args]) %>
 
     <% end %>
   </div>

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

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

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

@@ -10,12 +10,12 @@
     <p>Queries</p>
     <ul class="menu-root">
       <li>
-        <a href="<%= base_url %>/query/" class="sidebar-link<% if title == "Query" %> current<% end %>">
+        <a href="<%= base_url %>/operation/query/" class="sidebar-link<% if title == "Query" %> current<% end %>">
           Query
         </a>
       </li>
       <li>
-        <a href="<%= base_url %>/mutation" class="sidebar-link<% if title == "Mutation" %> current<% end %>">
+        <a href="<%= base_url %>/operation/mutation/" class="sidebar-link<% if title == "Mutation" %> current<% end %>">
           Mutation
         </a>
       </li>
@@ -26,19 +26,7 @@
     <p><a href="<%= base_url %>/object">Objects</a></p>
     <ul class="menu-root">
       <% graphql_object_types.().each do |type| %>
-        <% @name = type["name"] %>
-        <!-- skip connection stuff -->
-        <% next if @name.end_with?("Connection") || @name.end_with?("Edge") %>
-
-        <!-- skip mutation stuff -->
-        <% next if @name == "Mutation" || @name.end_with?("Payload") %>
-
-        <!-- skip metadata stuff -->
-        <% next if @name.start_with?("__") %>
-
-        <!-- skip root query stuff -->
-        <% next if @name == "Query" %>
-
+        <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/object/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
@@ -49,12 +37,10 @@
   </li>
 
   <li>
-    <p><a href="<%= base_url %>/mutation">Mutations</a></p>
+    <p><a href="<%= base_url %>/operation/mutation">Mutations</a></p>
     <ul class="menu-root">
       <% graphql_mutation_types.().each do |type| %>
-      <% @name = type["name"] %>
-      <!-- skip metadata stuff -->
-      <% next if @name.start_with?("__") %>
+      <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/mutation/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
@@ -68,7 +54,7 @@
     <p><a href="<%= base_url %>/interface">Interfaces</a></p>
     <ul class="menu-root">
       <% graphql_interface_types.().each do |type| %>
-        <% @name = type["name"] %>
+        <% @name = type[:name] %>
         <li>
           <a href="<%= base_url %>/interface/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
             <%= @name %>
@@ -82,9 +68,7 @@
     <p><a href="<%= base_url %>/enum">Enums</a></p>
     <ul class="menu-root">
       <% graphql_enum_types.().each do |type| %>
-      <% @name = type["name"] %>
-      <!-- skip metadata stuff -->
-      <% next if @name.start_with?("__") %>
+      <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/enum/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
@@ -98,7 +82,7 @@
     <p><a href="<%= base_url %>/union">Unions</a></p>
     <ul class="menu-root">
       <% graphql_union_types.().each do |type| %>
-      <% @name = type["name"] %>
+      <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/union/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
@@ -112,7 +96,7 @@
     <p><a href="<%= base_url %>/input_object">Input Objects</a></p>
     <ul class="menu-root">
       <% graphql_input_object_types.().each do |type| %>
-      <% @name = type["name"] %>
+      <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/input_object/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
@@ -126,7 +110,7 @@
     <p><a href="<%= base_url %>/scalar">Scalars</a></p>
     <ul class="menu-root">
       <% graphql_scalar_types.().each do |type| %>
-      <% @name = type["name"] %>
+      <% @name = type[:name] %>
       <li>
         <a href="<%= base_url %>/scalar/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>