graphqlmd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75e4efde27cb6b626368452682c61b319ab9ef2ee21f25bf1a6a9e2684e6fc3a
+  data.tar.gz: f5370b610c3628879e2c01d95bd4ac3465ec5dc24fe8a8b536fa0a7fb38bf36c
+SHA512:
+  metadata.gz: f51ece8322bb19a14015e111e2e64c8601eb5ed20ae4e7ef314c837ea927fce31e166b6b1acb6369540b8714e88e09e23c2ed4160c6d2e0e1dda3901b8a6b1d6
+  data.tar.gz: 3715e96440f72ee5c7661ae48f63b514c6e1121c9ed130e11a76846f5293ecc0c093d95d34a5b5dc58289d0d3173eb823c11f7e5bc8d3818c2d5d4e3757bb8d4

data/bin/graphqlmd

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'graphqlmd'
+require 'optparse'
+
+options = {
+  url: 'http://localhost:3000/graphql',
+  is_hide_client_mutation_id: true,
+  is_hide_scalar: true,
+  is_hide_deprecated: false,
+  is_allow_links: true,
+  is_vuepress: false
+}
+
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: graphqlmd [options]'
+
+  opts.on_tail '-v', '--version', 'Show version' do
+    puts "graphqlmd v#{Graphqlmd::VERSION}"
+    exit
+  end
+
+  opts.on(
+    '-u', '--url [URL]', "GraphQL schema url (default: #{options[:url]})"
+  ) do |url|
+    options[:url] = url
+  end
+
+  opts.on '--no-deprecated', 'Do not add deprecated objects, fields, args and etc.' do
+    options[:is_hide_deprecated] = true
+  end
+
+  opts.on '--no-links', 'Do not add links with anchors to docs' do
+    options[:is_allow_links] = false
+  end
+
+  opts.on '--client-mutation-id', 'Add clientMutationId to docs' do
+    options[:is_hide_client_mutation_id] = false
+  end
+
+  opts.on '--scalar', 'Add scalar objects to docs' do
+    options[:is_hide_scalar] = false
+  end
+
+  opts.on '--vuepress', 'Use vuepress additional styles' do
+    options[:is_vuepress] = true
+  end
+
+  opts.on_tail '-h', '--help', 'Show this message' do
+    puts opts
+    exit
+  end
+end.parse!
+
+::Graphqlmd::Graphqlmd.new(options).call

data/lib/graphqlmd.rb

@@ -0,0 +1,167 @@
+require 'graphqlmd/consts'
+require 'graphqlmd/version'
+require 'json'
+require 'net/http'
+require 'uri'
+
+class Graphqlmd::Graphqlmd
+  include ::Graphqlmd
+
+  def initialize options
+    @url = options[:url]
+    @is_hide_client_mutation_id = options[:is_hide_client_mutation_id]
+    @is_hide_deprecated = options[:is_hide_deprecated]
+    @is_hide_scalar = options[:is_hide_scalar]
+    @is_allow_links = options[:is_allow_links]
+    @is_vuepress = options[:is_vuepress]
+  end
+
+  def call
+    response = fetch_schema
+    data = JSON.parse(response.body).dig 'data', 'schema'
+    puts_queries data['queries']
+    puts_mutations data['mutations']
+    puts_objects data['types']
+  end
+
+private
+
+  def puts_queries data
+    print_header 'Queries'
+    queries = data['fields'].sort_by { |v| v['name'] }
+
+    queries.each do |v|
+      puts "\n### #{v['name']}\n"
+      print_deprecation v
+      puts "Return Type | Description\n"
+      puts "-|-\n"
+      puts "#{type_as_string v['type']} | #{print_description(v['description'])}\n"
+      print_args v['args']
+    end
+  end
+
+  def puts_mutations data
+    print_header 'Mutations'
+    mutations = data['fields'].sort_by { |v| v['name'] }
+    mutations = mutations.reject { |v| v['isDeprecated'] } if @is_hide_deprecated
+
+    mutations.each do |v|
+      puts "\n### #{v['name']}\n"
+      print_deprecation v
+      puts "Return Type | Description\n"
+      puts "-|-\n"
+      puts "#{type_as_string v['type']} | #{print_description(v['description'])}\n"
+      print_args v['args']
+    end
+  end
+
+  def puts_objects data
+    print_header 'Objects'
+    objects = data
+      .reject { |v| IGNORED_OBJECT_NAMES.include? v['name'] }
+      .sort_by { |v| v['name'] }
+    objects = objects.reject { |v| v['kind'] == SCALAR } if @is_hide_scalar
+
+    objects.each do |v|
+      puts "\n### #{v['name']}\n"
+      puts "#{print_description v['description']}\n" unless v['description'].nil?
+      print_fields v['fields'] || v['inputFields']
+    end
+
+    nil
+  end
+
+  def print_header value
+    puts "## #{value}\n"
+  end
+
+  def print_fields fields
+    return if fields.nil?
+    return if fields.empty?
+
+    puts "\n**Fields**\n"
+    puts "Name | Type | Description\n"
+    puts "-|-|-\n"
+    fields.each do |v|
+      next if v['name'] == CLIENT_MUTATION_ID && @is_hide_client_mutation_id
+
+      puts "#{v['name']} | #{type_as_string(v['type'])} | #{print_description(v['description'])}\n"
+    end
+  end
+
+  def print_args args
+    return if args.nil?
+    return if args.empty?
+
+    puts "#### Arguments\n"
+    puts "Name | Type | Description\n"
+    puts "-|-|-|-\n"
+    args.each do |v|
+      puts "#{v['name']} | #{type_as_string(v['type'])} | #{print_description(v['description'])}\n"
+    end
+  end
+
+  def print_description value
+    return if value.nil? || value.empty?
+
+    "_#{value}_"
+  end
+
+  def print_deprecation data
+    return unless data['isDeprecated']
+
+    if @is_vuepress
+      puts "::: warning DEPRECATED\n"
+      puts "#{data['deprecationReason']}\n"
+      puts ":::\n\n"
+    else
+      puts "> **DEPRECATED**\n"
+      puts ">\n"
+      puts "> #{data['deprecationReason']}\n\n"
+    end
+  end
+
+  def type_as_string type
+    is_required = type['kind'] == NON_NULL
+    is_list = type['kind'] == LIST
+
+    if type['name']
+      "#{name_as_link(type)}#{required_postfix(is_required)}"
+    elsif is_list
+      "[#{type_as_string(type['ofType'])}#{required_postfix(is_required)}]"
+    else
+      "#{type_as_string(type['ofType'])}#{required_postfix(is_required)}"
+    end
+  end
+
+  def required_postfix is_required
+    is_required ? '!' : ''
+  end
+
+  def name_as_link type
+    return type['name'] unless @is_allow_links
+    return type['name'] if type['kind'] == SCALAR
+
+    "[#{type['name']}](##{type['name'].downcase})"
+  end
+
+  def fetch_schema
+    uri = URI.parse @url
+
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      request = Net::HTTP::Post.new uri.request_uri, headers
+      request.body = body
+      http.request request
+    end
+  end
+
+  def headers
+    {
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  def body
+    { query: SCHEMA_QUERY, variables: nil }.to_json
+  end
+end

data/lib/graphqlmd/consts.rb

@@ -0,0 +1,106 @@
+module Graphqlmd
+  SCHEMA_QUERY = <<~QUERY
+    fragment FullType on __Type {
+      kind
+      name
+      description
+      fields(includeDeprecated: true) {
+        name
+        description
+        args {
+          ...InputValue
+        }
+        type {
+          ...TypeRef
+        }
+        isDeprecated
+        deprecationReason
+      }
+      inputFields {
+        ...InputValue
+      }
+      interfaces {
+        ...TypeRef
+      }
+      enumValues(includeDeprecated: true) {
+        name
+        isDeprecated
+        deprecationReason
+      }
+      possibleTypes {
+        ...TypeRef
+      }
+    }
+    fragment InputValue on __InputValue {
+      name
+      type {
+        ...TypeRef
+      }
+      defaultValue
+    }
+    fragment TypeRef on __Type {
+      kind
+      name
+      ofType {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+            ofType {
+              kind
+              name
+              ofType {
+                kind
+                name
+                ofType {
+                  kind
+                  name
+                  ofType {
+                    kind
+                    name
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+
+    {
+      schema:__schema {
+        queries:queryType {
+          ...FullType
+        }
+        mutations:mutationType {
+          ...FullType
+        }
+        types {
+          ...FullType
+        }
+      }
+    }
+  QUERY
+
+  LIST = 'LIST'
+  SCALAR = 'SCALAR'
+  NON_NULL = 'NON_NULL'
+  CLIENT_MUTATION_ID = 'clientMutationId'
+  IGNORED_OBJECT_NAMES = %w[
+    Query
+    Mutation
+    SCALAR
+    __DirectiveLocation
+    __TypeKind
+    __InputValue
+    __EnumValue
+    __Directive
+    __Field
+    __Type
+    __Schema
+  ]
+end

data/lib/graphqlmd/version.rb

@@ -0,0 +1,3 @@
+module Graphqlmd
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: graphqlmd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexander Kalinichev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-26 00:00:00.000000000 Z
+dependencies: []
+description: This gem will generate markdown by your GraphQL schema
+email: alex@agileseason.com
+executables:
+- graphqlmd
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/graphqlmd
+- lib/graphqlmd.rb
+- lib/graphqlmd/consts.rb
+- lib/graphqlmd/version.rb
+homepage: https://github.com/blackchestnut/graphqlmd
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: graphqlmd
+test_files: []