graphql-docs 1.9.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea32dc7266ed5483301f965839b71b611f17df3e87cdb1de18ed3ccbd4ff601e
-  data.tar.gz: 292fb21272e4293d4ed23ae996281d34522487ab71f47a13ae7943185407f2c1
+  metadata.gz: f020e4e5b4934ba5304c8b806fe7467580a69d6cf1c46bcfdb9da87616e5d7a2
+  data.tar.gz: 46221390779db63e655ee6056cb73e82d428d3e1447e49668023bf0adc0f3a50
 SHA512:
-  metadata.gz: e3108decb47aeaeddf1fdeef7c0f48cf55c03c0e413fb3354f595284977629704159ccaf0b6b574b5d0845301021fc6211a819138bdf6a63589dccb2e46cabff
-  data.tar.gz: 609e77fd5c372af5c23edc1893470ee835cae90f9f0587100542b2d6cd020c155973e78f7e0d59561d384bcced55dbc0bae436512af0fe1615b4ff97183d2ee6
+  metadata.gz: 1ea882325c99359946bc746a83e4b83c91bebd904b9021fb0ec28122a3f8a2d5ffeec287b15aefa5c83616442b6c5aa1b0d2ba7a426422270871d92cfcae5933
+  data.tar.gz: 57ad8d227e62610adb18e519e19dcdfef9254270244fe422afc0ff66357e5c3a03e1d5195d56a5d53e3f495da913a7b1bd63afeaada3b3c2a843229b2b0395bf

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: gjtorikian
+patreon: gjtorikian
+open_collective: garen-torikian
+#ko_fi: # Replace with a single Ko-fi username
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+issuehunt: gjtorikian
+#otechie: # Replace with a single Otechie username
+#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.travis.yml

@@ -3,10 +3,10 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - 2.6.0
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 
 git:
   depth: 10

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in graphql-docs.gemspec

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
@@ -31,7 +32,7 @@ task :console do
   require 'graphql-docs'
 
   def reload!
-    files = $LOADED_FEATURES.select { |feat| feat =~ /\/graphql-docs\// }
+    files = $LOADED_FEATURES.select { |feat| feat =~ %r{/graphql-docs/} }
     files.each { |file| load file }
   end
 
@@ -46,6 +47,7 @@ task :generate_sample do
 
   options = {}
   options[:delete_output] = true
+  options[:base_url] = ENV.fetch('GQL_DOCS_BASE_URL', '')
   options[:filename] = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
 
   GraphQLDocs.build(options)
@@ -65,6 +67,7 @@ end
 
 desc 'Generate and publish docs to gh-pages'
 task :publish do
+  ENV['GQL_DOCS_BASE_URL'] = '/graphql-docs'
   Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
   Dir.mktmpdir do |tmp|
     system "mv output/* #{tmp}"

data/graphql-docs.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'graphql-docs/version'
 
@@ -21,14 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '~> 1.8'
+  spec.add_dependency 'graphql', '~> 1.12'
 
   # rendering
   spec.add_dependency 'commonmarker', '~> 0.16'
-  spec.add_dependency 'html-pipeline', '~> 2.9'
-  spec.add_dependency 'escape_utils',  '~> 1.2'
+  spec.add_dependency 'escape_utils', '~> 1.2'
   spec.add_dependency 'extended-markdown-filter', '~> 0.4'
   spec.add_dependency 'gemoji', '~> 3.0'
+  spec.add_dependency 'html-pipeline', '~> 2.9'
   spec.add_dependency 'sass', '~> 3.4'
 
   spec.add_development_dependency 'awesome_print'

data/lib/graphql-docs/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GraphQLDocs
   module Configuration
     GRAPHQLDOCS_DEFAULTS = {
@@ -11,9 +12,9 @@ module GraphQLDocs
       output_dir: './output/',
       pipeline_config: {
         pipeline:
-          %i(ExtendedMarkdownFilter
-           EmojiFilter
-           TableOfContentsFilter),
+          %i[ExtendedMarkdownFilter
+             EmojiFilter
+             TableOfContentsFilter],
         context: {
           gfm: false,
           unsafe: true, # necessary for layout needs, given that it's all HTML templates
@@ -37,7 +38,7 @@ module GraphQLDocs
         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",
-        directives: "#{File.dirname(__FILE__)}/layouts/graphql_directives.html",
+        directives: "#{File.dirname(__FILE__)}/layouts/graphql_directives.html"
       },
 
       landing_pages: {
@@ -59,7 +60,7 @@ module GraphQLDocs
         field_entry: '',
         deprecation_notice: '',
         notice: '',
-        notice_title: '',
+        notice_title: ''
       }
     }.freeze
   end

data/lib/graphql-docs/generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erb'
 require 'sass'
 
@@ -14,14 +15,13 @@ module GraphQLDocs
 
       @renderer = @options[:renderer].new(@parsed_schema, @options)
 
-      %i(operations objects mutations interfaces enums unions input_objects scalars directives).each do |sym|
-        if !File.exist?(@options[:templates][sym])
-          raise IOError, "`#{sym}` template #{@options[:templates][sym]} was not found"
-        end
+      %i[operations objects mutations interfaces enums unions input_objects scalars directives].each do |sym|
+        raise IOError, "`#{sym}` template #{@options[:templates][sym]} was not found" unless File.exist?(@options[:templates][sym])
+
         instance_variable_set("@graphql_#{sym}_template", ERB.new(File.read(@options[:templates][sym])))
       end
 
-      %i(index object query mutation interface enum union input_object scalar directive).each do |sym|
+      %i[index object query mutation interface enum union input_object scalar directive].each do |sym|
         if @options[:landing_pages][sym].nil?
           instance_variable_set("@#{sym}_landing_page", nil)
         elsif !File.exist?(@options[:landing_pages][sym])
@@ -33,7 +33,7 @@ module GraphQLDocs
 
         if File.extname((@options[:landing_pages][sym])) == '.erb'
           opts = @options.merge(@options[:landing_pages][:variables]).merge(helper_methods)
-          if has_yaml?(landing_page_contents)
+          if yaml?(landing_page_contents)
             metadata, landing_page = split_into_metadata_and_contents(landing_page_contents, parse: false)
             erb_template = ERB.new(landing_page)
           else
@@ -60,45 +60,25 @@ module GraphQLDocs
       create_graphql_scalar_pages
       create_graphql_directive_pages
 
-      unless @graphql_index_landing_page.nil?
-        write_file('static', 'index', @graphql_index_landing_page, trim: false)
-      end
+      write_file('static', 'index', @graphql_index_landing_page, trim: false) unless @graphql_index_landing_page.nil?
 
-      unless @graphql_object_landing_page.nil?
-        write_file('static', 'object', @graphql_object_landing_page, trim: false)
-      end
+      write_file('static', 'object', @graphql_object_landing_page, trim: false) unless @graphql_object_landing_page.nil?
 
-      if !@graphql_query_landing_page.nil? && !has_query
-        write_file('operation', 'query', @graphql_query_landing_page, trim: false)
-      end
+      write_file('operation', 'query', @graphql_query_landing_page, trim: false) if !@graphql_query_landing_page.nil? && !has_query
 
-      unless @graphql_mutation_landing_page.nil?
-        write_file('operation', 'mutation', @graphql_mutation_landing_page, trim: false)
-      end
+      write_file('operation', 'mutation', @graphql_mutation_landing_page, trim: false) unless @graphql_mutation_landing_page.nil?
 
-      unless @graphql_interface_landing_page.nil?
-        write_file('static', 'interface', @graphql_interface_landing_page, trim: false)
-      end
+      write_file('static', 'interface', @graphql_interface_landing_page, trim: false) unless @graphql_interface_landing_page.nil?
 
-      unless @graphql_enum_landing_page.nil?
-        write_file('static', 'enum', @graphql_enum_landing_page, trim: false)
-      end
+      write_file('static', 'enum', @graphql_enum_landing_page, trim: false) unless @graphql_enum_landing_page.nil?
 
-      unless @graphql_union_landing_page.nil?
-        write_file('static', 'union', @graphql_union_landing_page, trim: false)
-      end
+      write_file('static', 'union', @graphql_union_landing_page, trim: false) unless @graphql_union_landing_page.nil?
 
-      unless @graphql_input_object_landing_page.nil?
-        write_file('static', 'input_object', @graphql_input_object_landing_page, trim: false)
-      end
+      write_file('static', 'input_object', @graphql_input_object_landing_page, trim: false) unless @graphql_input_object_landing_page.nil?
 
-      unless @graphql_scalar_landing_page.nil?
-        write_file('static', 'scalar', @graphql_scalar_landing_page, trim: false)
-      end
+      write_file('static', 'scalar', @graphql_scalar_landing_page, trim: false) unless @graphql_scalar_landing_page.nil?
 
-      unless @graphql_directive_landing_page.nil?
-        write_file('static', 'directive', @graphql_directive_landing_page, trim: false)
-      end
+      write_file('static', 'directive', @graphql_directive_landing_page, trim: false) unless @graphql_directive_landing_page.nil?
 
       if @options[:use_default_styles]
         assets_dir = File.join(File.dirname(__FILE__), 'layouts', 'assets')
@@ -117,23 +97,23 @@ module GraphQLDocs
     def create_graphql_query_pages
       graphql_operation_types.each do |query_type|
         metadata = ''
-        if query_type[:name] == graphql_root_types['query']
-          unless @options[:landing_pages][:query].nil?
-            query_landing_page = @options[:landing_pages][:query]
-            query_landing_page = File.read(query_landing_page)
-            if has_yaml?(query_landing_page)
-              pieces = yaml_split(query_landing_page)
-              pieces[2] = pieces[2].chomp
-              metadata = pieces[1, 3].join("\n")
-              query_landing_page = pieces[4]
-            end
-            query_type[:description] = query_landing_page
+        next unless query_type[:name] == graphql_root_types['query']
+
+        unless @options[:landing_pages][:query].nil?
+          query_landing_page = @options[:landing_pages][:query]
+          query_landing_page = File.read(query_landing_page)
+          if yaml?(query_landing_page)
+            pieces = yaml_split(query_landing_page)
+            pieces[2] = pieces[2].chomp
+            metadata = pieces[1, 3].join("\n")
+            query_landing_page = pieces[4]
           end
-          opts = default_generator_options(type: query_type)
-          contents = @graphql_operations_template.result(OpenStruct.new(opts).instance_eval { binding })
-          write_file('operation', 'query', metadata + contents)
-          return true
+          query_type[:description] = query_landing_page
         end
+        opts = default_generator_options(type: query_type)
+        contents = @graphql_operations_template.result(OpenStruct.new(opts).instance_eval { binding })
+        write_file('operation', 'query', metadata + contents)
+        return true
       end
       false
     end
@@ -229,7 +209,7 @@ module GraphQLDocs
         FileUtils.mkdir_p(path)
       end
 
-      if has_yaml?(contents)
+      if yaml?(contents)
         # Split data
         meta, contents = split_into_metadata_and_contents(contents)
         @options = @options.merge(meta)

data/lib/graphql-docs/helpers.rb

@@ -10,7 +10,7 @@ module GraphQLDocs
 
     def slugify(str)
       slug = str.gsub(SLUGIFY_PRETTY_REGEXP, '-')
-      slug.gsub!(%r!^\-|\-$!i, '')
+      slug.gsub!(/^\-|\-$/i, '')
       slug.downcase
     end
 
@@ -22,6 +22,7 @@ module GraphQLDocs
 
     def markdownify(string)
       return '' if string.nil?
+
       type = @options[:pipeline_config][:context][:unsafe] ? :UNSAFE : :DEFAULT
       ::CommonMarker.render_html(string, type).strip
     end
@@ -67,27 +68,23 @@ module GraphQLDocs
     end
 
     def split_into_metadata_and_contents(contents, parse: true)
-      opts = {}
       pieces = yaml_split(contents)
-      if pieces.size < 4
-        raise RuntimeError.new(
-          "The file '#{content_filename}' appears to start with a metadata section (three or five dashes at the top) but it does not seem to be in the correct format.",
-        )
-      end
+      raise "The file '#{content_filename}' appears to start with a metadata section (three or five dashes at the top) but it does not seem to be in the correct format." if pieces.size < 4
+
       # Parse
       begin
-        if parse
-          meta = YAML.load(pieces[2]) || {}
-        else
-          meta = pieces[2]
-        end
+        meta = if parse
+                 YAML.safe_load(pieces[2]) || {}
+               else
+                 pieces[2]
+               end
       rescue Exception => e # rubocop:disable Lint/RescueException
         raise "Could not parse YAML for #{name}: #{e.message}"
       end
       [meta, pieces[4]]
     end
 
-    def has_yaml?(contents)
+    def yaml?(contents)
       contents =~ /\A-{3,5}\s*$/
     end
 
@@ -114,6 +111,7 @@ module GraphQLDocs
 
       Helpers.instance_methods.each do |name|
         next if name == :helper_methods
+
         @helper_methods[name] = method(name)
       end
 

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

@@ -37,7 +37,7 @@
 
       <!-- mobile only -->
       <div id="mobile-header">
-        <a class="menu-button"></a>
+        <a class="menu-button" onclick="document.body.classList.toggle('sidebar-open')"></a>
         <a class="logo" href="<%= base_url.present? ? base_url : '/' %>">
 
         </a>

data/lib/graphql-docs/parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'graphql'
 
 module GraphQLDocs
@@ -10,13 +11,13 @@ module GraphQLDocs
     def initialize(schema, options)
       @options = options
 
-      @options[:notices] ||= -> (schema_member_path) { [] }
+      @options[:notices] ||= ->(_schema_member_path) { [] }
 
-      if schema.is_a?(GraphQL::Schema)
-        @schema = schema
-      else
-        @schema = GraphQL::Schema.from_definition(schema)
-      end
+      @schema = if schema.is_a?(String)
+                  GraphQL::Schema.from_definition(schema)
+                elsif schema < GraphQL::Schema
+                  schema
+                end
 
       @processed_schema = {
         operation_types: [],
@@ -27,81 +28,71 @@ module GraphQLDocs
         union_types: [],
         input_object_types: [],
         scalar_types: [],
-        directive_types: [],
+        directive_types: []
       }
     end
 
     def parse
-
       root_types = {}
-      ['query', 'mutation'].each do |operation|
-        unless @schema.root_type_for_operation(operation).nil?
-          root_types[operation] = @schema.root_type_for_operation(operation).name
-        end
+      %w[query mutation].each do |operation|
+        root_types[operation] = @schema.root_type_for_operation(operation).graphql_name unless @schema.root_type_for_operation(operation).nil?
       end
       @processed_schema[:root_types] = root_types
 
       @schema.types.each_value do |object|
         data = {}
 
-        data[:notices] = @options[:notices].call(object.name)
+        data[:notices] = @options[:notices].call(object.graphql_name)
 
-        case object
-        when ::GraphQL::ObjectType
-          if object.name == root_types['query']
-            data[:name] = object.name
-            data[:description] = object.description
+        if object < ::GraphQL::Schema::Object
+          data[:name] = object.graphql_name
+          data[:description] = object.description
 
-            data[:interfaces] = object.interfaces.map(&:name).sort
-            data[:fields], data[:connections] = fetch_fields(object.fields, object.name)
+          if data[:name] == root_types['query']
+            data[:interfaces] = object.interfaces.map(&:graphql_name).sort
+            data[:fields], data[:connections] = fetch_fields(object.fields, object.graphql_name)
 
             @processed_schema[:operation_types] << data
-          elsif object.name == root_types['mutation']
-            data[:name] = object.name
-            data[:description] = object.description
-
+          elsif data[:name] == root_types['mutation']
             @processed_schema[:operation_types] << data
 
             object.fields.each_value do |mutation|
               h = {}
 
-              h[:notices] = @options[:notices].call([object.name, mutation.name].join('.'))
-              h[:name] = mutation.name
+              h[:notices] = @options[:notices].call([object.graphql_name, mutation.graphql_name].join('.'))
+              h[:name] = mutation.graphql_name
               h[:description] = mutation.description
-              h[:input_fields], _ = fetch_fields(mutation.arguments, [object.name, mutation.name].join('.'))
+              h[:input_fields], = fetch_fields(mutation.arguments, [object.graphql_name, mutation.graphql_name].join('.'))
 
               return_type = mutation.type
               if return_type.unwrap.respond_to?(:fields)
-                h[:return_fields], _ = fetch_fields(return_type.unwrap.fields, return_type.name)
+                h[:return_fields], = fetch_fields(return_type.unwrap.fields, return_type.graphql_name)
               else # it is a scalar return type
-                h[:return_fields], _ = fetch_fields({ "#{return_type.name}" => mutation }, return_type.name)
+                h[:return_fields], = fetch_fields({ return_type.graphql_name => mutation }, return_type.graphql_name)
               end
 
               @processed_schema[:mutation_types] << h
             end
           else
-            data[:name] = object.name
-            data[:description] = object.description
-
-            data[:interfaces] = object.interfaces.map(&:name).sort
-            data[:fields], data[:connections] = fetch_fields(object.fields, object.name)
+            data[:interfaces] = object.interfaces.map(&:graphql_name).sort
+            data[:fields], data[:connections] = fetch_fields(object.fields, object.graphql_name)
 
             @processed_schema[:object_types] << data
           end
-        when ::GraphQL::InterfaceType
-          data[:name] = object.name
+        elsif object < ::GraphQL::Schema::Interface
+          data[:name] = object.graphql_name
           data[:description] = object.description
-          data[:fields], data[:connections] = fetch_fields(object.fields, object.name)
+          data[:fields], data[:connections] = fetch_fields(object.fields, object.graphql_name)
 
           @processed_schema[:interface_types] << data
-        when ::GraphQL::EnumType
-          data[:name] = object.name
+        elsif object < ::GraphQL::Schema::Enum
+          data[:name] = object.graphql_name
           data[:description] = object.description
 
           data[:values] = object.values.values.map do |val|
             h = {}
-            h[:notices] = @options[:notices].call([object.name, val.name].join('.'))
-            h[:name] = val.name
+            h[:notices] = @options[:notices].call([object.graphql_name, val.graphql_name].join('.'))
+            h[:name] = val.graphql_name
             h[:description] = val.description
             unless val.deprecation_reason.nil?
               h[:is_deprecated] = true
@@ -111,38 +102,38 @@ module GraphQLDocs
           end
 
           @processed_schema[:enum_types] << data
-        when ::GraphQL::UnionType
-          data[:name] = object.name
+        elsif object < ::GraphQL::Schema::Union
+          data[:name] = object.graphql_name
           data[:description] = object.description
-          data[:possible_types] = object.possible_types.map(&:name).sort
+          data[:possible_types] = object.possible_types.map(&:graphql_name).sort
 
           @processed_schema[:union_types] << data
-        when ::GraphQL::InputObjectType
-          data[:name] = object.name
+        elsif object < GraphQL::Schema::InputObject
+          data[:name] = object.graphql_name
           data[:description] = object.description
 
-          data[:input_fields], _ = fetch_fields(object.input_fields, object.name)
+          data[:input_fields], = fetch_fields(object.arguments, object.graphql_name)
 
           @processed_schema[:input_object_types] << data
-        when ::GraphQL::ScalarType
-          data[:name] = object.name
+        elsif object < GraphQL::Schema::Scalar
+          data[:name] = object.graphql_name
           data[:description] = object.description
 
           @processed_schema[:scalar_types] << data
         else
-          raise TypeError, "I'm not sure what #{object.class} is!"
+          raise TypeError, "I'm not sure what #{object.class} < #{object.superclass.name} is!"
         end
       end
 
       @schema.directives.each_value do |directive|
         data = {}
-        data[:notices] = @options[:notices].call(directive.name)
+        data[:notices] = @options[:notices].call(directive.graphql_name)
 
-        data[:name] = directive.name
+        data[:name] = directive.graphql_name
         data[:description] = directive.description
         data[:locations] = directive.locations
 
-        data[:arguments], _ = fetch_fields(directive.arguments, directive.name)
+        data[:arguments], = fetch_fields(directive.arguments, directive.graphql_name)
 
         @processed_schema[:directive_types] << data
       end
@@ -152,9 +143,7 @@ module GraphQLDocs
       @processed_schema[:interface_types].each do |interface|
         interface[:implemented_by] = []
         @processed_schema[:object_types].each do |obj|
-          if obj[:interfaces].include?(interface[:name])
-            interface[:implemented_by] << obj[:name]
-          end
+          interface[:implemented_by] << obj[:name] if obj[:interfaces].include?(interface[:name])
         end
       end
 
@@ -170,8 +159,8 @@ module GraphQLDocs
       object_fields.each_value do |field|
         hash = {}
 
-        hash[:notices] = @options[:notices].call([parent_path, field.name].join('.'))
-        hash[:name] = field.name
+        hash[:notices] = @options[:notices].call([parent_path, field.graphql_name].join('.'))
+        hash[:name] = field.graphql_name
         hash[:description] = field.description
         if field.respond_to?(:deprecation_reason) && !field.deprecation_reason.nil?
           hash[:is_deprecated] = true
@@ -184,17 +173,15 @@ module GraphQLDocs
         if field.respond_to?(:arguments)
           field.arguments.each_value do |arg|
             h = {}
-            h[:name] = arg.name
+            h[:name] = arg.graphql_name
             h[:description] = arg.description
             h[:type] = generate_type(arg.type)
-            if arg.default_value?
-              h[:default_value] = arg.default_value
-            end
+            h[:default_value] = arg.default_value if arg.default_value?
             hash[:arguments] << h
           end
         end
 
-        if !argument?(field) && field.connection?
+        if !argument?(field) && connection?(field)
           connections << hash
         else
           fields << hash
@@ -205,42 +192,48 @@ module GraphQLDocs
     end
 
     def generate_type(type)
-      name = type.unwrap.to_s
-      path = case type.unwrap
-             when ::GraphQL::ObjectType
+      name = type.unwrap.graphql_name
+
+      path = if type.unwrap < GraphQL::Schema::Object
                if name == 'Query'
                  'operation'
                else
                  'object'
                end
-             when ::GraphQL::ScalarType
+             elsif type.unwrap < GraphQL::Schema::Scalar
                'scalar'
-             when ::GraphQL::InterfaceType
+             elsif type.unwrap < GraphQL::Schema::Interface
                'interface'
-             when ::GraphQL::EnumType
+             elsif type.unwrap < GraphQL::Schema::Enum
                'enum'
-             when ::GraphQL::InputObjectType
+             elsif type.unwrap < GraphQL::Schema::InputObject
                'input_object'
-             when ::GraphQL::UnionType
+             elsif type.unwrap < GraphQL::Schema::Union
                'union'
              else
-               raise TypeError, "Unknown type: `#{type.unwrap.class}`"
+               raise TypeError, "Unknown type for `#{name}`: `#{type.unwrap.class}`"
              end
 
       {
         name: name,
-        path: path + '/' + slugify(name),
-        info: type.to_s
+        path: "#{path}/#{slugify(name)}",
+        info: type.to_type_signature
       }
     end
 
     def argument?(field)
-      field.is_a?(::GraphQL::Argument)
+      field.is_a?(::GraphQL::Schema::Argument)
+    end
+
+    def connection?(field)
+      field.respond_to?(:connection?) && field.connection?
     end
 
     def sort_by_name!
       @processed_schema.each_pair do |key, value|
-        next if key == :operation_types || key == :root_types
+        next if value.empty?
+        next if %i[operation_types root_types].include?(key)
+
         value.sort_by! { |o| o[:name] }
       end
     end

data/lib/graphql-docs/renderer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'html/pipeline'
 require 'yaml'
 require 'extended-markdown-filter'
@@ -13,9 +14,7 @@ module GraphQLDocs
       @parsed_schema = parsed_schema
       @options = options
 
-      unless @options[:templates][:default].nil?
-        @graphql_default_layout = ERB.new(File.read(@options[:templates][:default]))
-      end
+      @graphql_default_layout = ERB.new(File.read(@options[:templates][:default])) unless @options[:templates][:default].nil?
 
       @pipeline_config = @options[:pipeline_config] || {}
       pipeline = @pipeline_config[:pipeline] || {}
@@ -40,10 +39,11 @@ module GraphQLDocs
     end
 
     def render(contents, type: nil, name: nil, filename: nil)
-      opts = { base_url: @options[:base_url], output_dir: @options[:output_dir] }.merge({ type: type, name: name, filename: filename}).merge(helper_methods)
+      opts = { base_url: @options[:base_url], output_dir: @options[:output_dir] }.merge({ type: type, name: name, filename: filename }).merge(helper_methods)
 
       contents = to_html(contents, context: { filename: filename })
       return contents if @graphql_default_layout.nil?
+
       opts[:content] = contents
       @graphql_default_layout.result(OpenStruct.new(opts).instance_eval { binding })
     end
@@ -54,12 +54,12 @@ module GraphQLDocs
 
     private
 
-    def filter_key(s)
-      s.downcase
+    def filter_key(str)
+      str.downcase
     end
 
-    def filter?(f)
-      f < HTML::Pipeline::Filter
+    def filter?(filter)
+      filter < HTML::Pipeline::Filter
     rescue LoadError, ArgumentError
       false
     end

data/lib/graphql-docs/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GraphQLDocs
-  VERSION = '1.9.0'.freeze
+  VERSION = '2.1.0'
 end

data/lib/graphql-docs.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'graphql-docs/helpers'
 require 'graphql-docs/renderer'
 require 'graphql-docs/configuration'
@@ -9,19 +10,16 @@ require 'graphql-docs/version'
 begin
   require 'awesome_print'
   require 'pry'
-rescue LoadError; end
-
+rescue LoadError; end # rubocop:disable Lint/SuppressedException
 module GraphQLDocs
   class << self
     def build(options)
       # do not let user provided values overwrite every single value
-      %i(templates landing_pages).each do |opt|
-        if options.key?(opt)
-          GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS[opt].each_pair do |key, value|
-            unless options[opt].key?(key)
-              options[opt][key] = value
-            end
-          end
+      %i[templates landing_pages].each do |opt|
+        next unless options.key?(opt)
+
+        GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS[opt].each_pair do |key, value|
+          options[opt][key] = value unless options[opt].key?(key)
         end
       end
 
@@ -30,28 +28,18 @@ module GraphQLDocs
       filename = options[:filename]
       schema = options[:schema]
 
-      if !filename.nil? && !schema.nil?
-        raise ArgumentError, 'Pass in `filename` or `schema`, but not both!'
-      end
+      raise ArgumentError, 'Pass in `filename` or `schema`, but not both!' if !filename.nil? && !schema.nil?
 
-      if filename.nil? && schema.nil?
-        raise ArgumentError, 'Pass in either `filename` or `schema`'
-      end
+      raise ArgumentError, 'Pass in either `filename` or `schema`' if filename.nil? && schema.nil?
 
       if filename
-        unless filename.is_a?(String)
-          raise TypeError, "Expected `String`, got `#{filename.class}`"
-        end
+        raise TypeError, "Expected `String`, got `#{filename.class}`" unless filename.is_a?(String)
 
-        unless File.exist?(filename)
-          raise ArgumentError, "#{filename} does not exist!"
-        end
+        raise ArgumentError, "#{filename} does not exist!" unless File.exist?(filename)
 
         schema = File.read(filename)
       else
-        if !schema.is_a?(String) && !schema.is_a?(GraphQL::Schema)
-          raise TypeError, "Expected `String` or `GraphQL::Schema`, got `#{schema.class}`"
-        end
+        raise TypeError, "Expected `String` or `GraphQL::Schema`, got `#{schema.class}`" if !schema.is_a?(String) && !schema_type?(schema)
 
         schema = schema
       end
@@ -63,5 +51,9 @@ module GraphQLDocs
 
       generator.generate
     end
+
+    private def schema_type?(object)
+      object.respond_to?(:ancestors) && object.ancestors.include?(GraphQL::Schema)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Garen Torikian
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: html-pipeline
+  name: escape_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: escape_utils
+  name: extended-markdown-filter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: extended-markdown-filter
+  name: gemoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: gemoji
+  name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -248,13 +248,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: 
+description:
 email:
 - gjtorikian@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -339,7 +340,7 @@ homepage: https://github.com/gjtorikian/graphql-docs
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -354,9 +355,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Easily generate beautiful documentation from your GraphQL schema.
 test_files: []