graphql-docs 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52fce6b1ce93964752a369845d20269143a7de19
-  data.tar.gz: 7093f056049df6a535b6f4fc062bbfcdac0569cd
+  metadata.gz: 73edf72a2d765a3e79d721c603acc05832fae79f
+  data.tar.gz: a5f747385749b0babc5a2c42a60c7cbb98633a25
 SHA512:
-  metadata.gz: 02784227566c19b28b1cacc14a7f00fcd602d1d0481e15d9aa016427bf815762034e0dbafba245a6203dc3182ae9d54f45a25d98b983fe606690010f2b575680
-  data.tar.gz: 45ef57c2ef354db1a765fc83f23d202933c9c2b3cc93ee0524c2ff954c43df731e5e7e99c89689addd5fea9863dbc2ef139d2483336d9f2d03db1d8fb0aa413f
+  metadata.gz: 8846e1d564b782a17205374cbc151da843fdee19b4b967a54bb5cc889a7034a6fbe0e8b61e0141a0bfd78584c4c08a80437e0bad27755613859c41c867e7ca83
+  data.tar.gz: 060991173dbeedbb7b173f9c4c4f4c0b666f7b1f51d8214113c27fcf93c59550402eed3746efa508301cf274425817f9af59da29f810e8d31e83f149504629e2

data/README.md

@@ -134,6 +134,7 @@ The following options are available:
 | `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`, `index`. | The defaults are found in _lib/graphql-docs/layouts/_.
+| `classes` | Additional class names you can provide to certain elements. | The full list is found in _lib/graphql-docs/configuration.rb/_.
 
 ## Development
 

data/lib/graphql-docs/configuration.rb

@@ -38,6 +38,11 @@ module GraphQLDocs
         scalars: "#{File.dirname(__FILE__)}/layouts/graphql_scalars.html",
 
         index: "#{File.dirname(__FILE__)}/layouts/index.md",
+      },
+
+      classes: {
+        field_entry: '',
+        deprecation_notice: ''
       }
     }.freeze
   end

data/lib/graphql-docs/helpers.rb

@@ -12,7 +12,7 @@ module GraphQLDocs
 
     def include(filename, opts = {})
       template = fetch_include(filename)
-      opts = { base_url: @options[:base_url] }.merge(opts)
+      opts = { base_url: @options[:base_url], classes: @options[:classes] }.merge(opts)
       template.result(OpenStruct.new(opts.merge(helper_methods)).instance_eval { binding })
     end
 

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

@@ -1,6 +1,6 @@
 <% connections.each do |connection| %>
 
-<div class="field-entry my-4">
+<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>
 
   <div class="description-wrapper">

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

@@ -2,7 +2,7 @@
 
 <% next if field['type']['ofType'] && field['type']['ofType']['name'] && field['type']['ofType']['name'].end_with?('Connection') %>
 
-<div class="field-entry">
+<div class="field-entry <%= classes[:field_entry] %>">
   <% next if field['name'] == "id" || field['name'].blank? %>
 
   <% if field['type']['ofType'] && !field['type']['ofType']['ofType'].nil? %>
@@ -28,7 +28,7 @@
 
   <div class="description-wrapper">
     <% if field['isDeprecated'] %>
-      <div class="deprecation-notice">
+      <div class="deprecation-notice <%= classes[:deprecation_notice] %>">
         <span class="deprecation-title">Deprecation notice</span>
         <%= markdown.(field['deprecationReason']) %>
       </div>

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

@@ -4,7 +4,7 @@
 
 <% next if field['type']['ofType'] && field['type']['ofType']['name'] && field['type']['ofType']['name'].end_with?('Connection') %>
 
-<div class="field-entry">
+<div class="field-entry <%= classes[:field_entry] %>">
   <% next if field['name'] == "id" || field['name'].blank? %>
 
   <% if field['type']['ofType'] && !field['type']['ofType']['ofType'].nil? %>

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

@@ -43,7 +43,7 @@
         <% end %>
 
       <li>
-        <a href="<%= base_url %>/object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/object/<%= @name.downcase %>/" 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="<%= base_url %>/interface/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+          <a href="<%= base_url %>/interface/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
             <%= @name %>
           </a>
         </li>
@@ -75,7 +75,7 @@
         <% next %>
       <% end %>
       <li>
-        <a href="<%= base_url %>/enum/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/enum/<%= @name.downcase %>/" 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="<%= base_url %>/union/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/union/<%= @name.downcase %>/" 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="<%= base_url %>/input_object/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/input_object/<%= @name.downcase %>/" 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="<%= base_url %>/scalar/<%= @name.downcase %>/index.html" class="sidebar-link<% if title == @name %> current<% end %>">
+        <a href="<%= base_url %>/scalar/<%= @name.downcase %>/" class="sidebar-link<% if title == @name %> current<% end %>">
           <%= @name %>
         </a>
       </li>

data/lib/graphql-docs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday