graphql-docs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73edf72a2d765a3e79d721c603acc05832fae79f
-  data.tar.gz: a5f747385749b0babc5a2c42a60c7cbb98633a25
+  metadata.gz: 4935d2987679ab16e3a82d24f4839b484dbc289e
+  data.tar.gz: f4ddc20c6c2702e28b17c7c64648811d59a017ff
 SHA512:
-  metadata.gz: 8846e1d564b782a17205374cbc151da843fdee19b4b967a54bb5cc889a7034a6fbe0e8b61e0141a0bfd78584c4c08a80437e0bad27755613859c41c867e7ca83
-  data.tar.gz: 060991173dbeedbb7b173f9c4c4f4c0b666f7b1f51d8214113c27fcf93c59550402eed3746efa508301cf274425817f9af59da29f810e8d31e83f149504629e2
+  metadata.gz: d5bdeee0342d29830457a27c24924c14db9b4850fa75bc751abf449ae0c95c0dce091c5a7f4bea41423e864935c7ca82cda939bf81b7071154d3291db67844ca
+  data.tar.gz: '018e1e9d4f837d7a326a430cbb75fe76cba0d5ff3731ef25b3dff54074ca6ab3bfb9ce596fd9ad9e95b030d9f0ab7bec9d550adbda28776ec1ffb13c970df09c'

data/README.md

@@ -112,6 +112,7 @@ 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.
+* `format_type(field)` - This formats a type into an IDL-like representation. For example: `!Blah` or `[!Foo]`.
 * `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 within templates, you must use the dot notation, such as `<%= slugify.(text) %>`.

data/graphql-docs.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   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 'rake'
   spec.add_development_dependency 'rubocop-github'
   spec.add_development_dependency 'webmock', '~> 2.3'
 end

data/lib/graphql-docs/helpers.rb

@@ -20,6 +20,63 @@ module GraphQLDocs
       GitHub::Markdown.render(string || 'n/a')
     end
 
+    # Do you think I am proud of this? I am not.
+    def format_type(field)
+      type_path = name_slug = nil
+      type_name = ''
+
+      if field['type']['kind'] == 'NON_NULL'
+        type_name << '!'
+
+        if !field['type']['ofType']['ofType'].nil?
+          # we're going to be a list...but what kind?!
+          type_name << '['
+          if !field['type']['ofType']['ofType']['ofType'].nil?
+            # A required list of required items: ![!Blah]
+            if field['type']['ofType']['ofType']['kind'] == 'NON_NULL'
+              type_name << '!'
+            end
+            type_path = field['type']['ofType']['ofType']['ofType']['kind']
+            type_name << field['type']['ofType']['ofType']['ofType']['name']
+            name_slug = field['type']['ofType']['ofType']['ofType']['name']
+          else
+            # A required list of non-required items: ![Blah]
+            type_path = field['type']['ofType']['ofType']['kind']
+            type_name << field['type']['ofType']['ofType']['name']
+            name_slug = field['type']['ofType']['ofType']['name']
+          end
+          type_name << ']'
+        else
+          # Simple non-null item: !Blah
+          type_path = field['type']['ofType']['kind']
+          type_name << field['type']['ofType']['name']
+          name_slug = field['type']['ofType']['name']
+        end
+      elsif field['type']['kind'] == 'LIST'
+        type_name << '['
+        if field['type']['ofType']['kind'] == 'NON_NULL'
+          # Nullable list of non-null items: [!Blah]
+          type_name << '!'
+          type_path = field['type']['ofType']['ofType']['kind']
+          type_name << field['type']['ofType']['ofType']['name']
+          name_slug = field['type']['ofType']['ofType']['name']
+        else
+          # Nullable list of nullable items: [Blah]
+          type_path = field['type']['ofType']['kind']
+          type_name << field['type']['ofType']['name']
+          name_slug = field['type']['ofType']['name']
+        end
+        type_name << ']'
+      else
+        # Simple nullable item: Blah
+        type_path = field['type']['kind']
+        type_name << field['type']['name']
+        name_slug = field['type']['name']
+      end
+
+      [type_path.downcase, type_name, name_slug.downcase]
+    end
+
     def graphql_mutation_types
       @parsed_schema['mutation_types']
     end

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

@@ -9,18 +9,12 @@
   <tbody>
   <% args.each do |argument| %>
   <tr>
-    <td><code><%= argument['name'] %><code></td>
+    <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 %>
+      <% @type_path, @type_name, @name_slug = format_type.(argument) %>
 
-      <code><%= @arg_name %></code>
+      <code><a href="<%= base_url %>/<%= @type_path %>/<%= @name_slug %>"><%= @type_name %></a></code>
     </td>
     <td>
       <p><%= markdown.(argument['description']) %></p>

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

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

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

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

data/lib/graphql-docs/version.rb

@@ -1,3 +1,3 @@
 module GraphQLDocs
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -196,16 +196,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
@@ -328,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Easily generate beautiful documentation from your GraphQL schema.