104 lines
3.1 KiB
Ruby
104 lines
3.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
return if Rails.env.production?
|
|
|
|
module Gitlab
|
|
module Graphql
|
|
module Docs
|
|
# Helper with functions to be used by HAML templates
|
|
# This includes graphql-docs gem helpers class.
|
|
# You can check the included module on: https://github.com/gjtorikian/graphql-docs/blob/v1.6.0/lib/graphql-docs/helpers.rb
|
|
module Helper
|
|
include GraphQLDocs::Helpers
|
|
|
|
def auto_generated_comment
|
|
<<-MD.strip_heredoc
|
|
<!---
|
|
This documentation is auto generated by a script.
|
|
|
|
Please do not edit this file directly, check compile_docs task on lib/tasks/gitlab/graphql.rake.
|
|
--->
|
|
MD
|
|
end
|
|
|
|
def render_name_and_description(object)
|
|
content = "### #{object[:name]}\n"
|
|
|
|
if object[:description].present?
|
|
content += "\n#{object[:description]}.\n"
|
|
end
|
|
|
|
content
|
|
end
|
|
|
|
def sorted_by_name(objects)
|
|
objects.sort_by { |o| o[:name] }
|
|
end
|
|
|
|
def render_field(field)
|
|
'| %s | %s | %s |' % [
|
|
render_name(field),
|
|
render_field_type(field[:type][:info]),
|
|
render_description(field)
|
|
]
|
|
end
|
|
|
|
def render_enum_value(value)
|
|
'| %s | %s |' % [
|
|
render_name(value),
|
|
render_description(value)
|
|
]
|
|
end
|
|
|
|
def render_name(object)
|
|
rendered_name = "`#{object[:name]}`"
|
|
rendered_name += ' **{warning-solid}**' if object[:is_deprecated]
|
|
rendered_name
|
|
end
|
|
|
|
# Returns the object description. If the object has been deprecated,
|
|
# the deprecation reason will be returned in place of the description.
|
|
def render_description(object)
|
|
return object[:description] unless object[:is_deprecated]
|
|
|
|
"**Deprecated:** #{object[:deprecation_reason]}"
|
|
end
|
|
|
|
# Some fields types are arrays of other types and are displayed
|
|
# on docs wrapped in square brackets, for example: [String!].
|
|
# This makes GitLab docs renderer thinks they are links so here
|
|
# we change them to be rendered as: String! => Array.
|
|
def render_field_type(type)
|
|
array_type = type[/\[(.+)\]/, 1]
|
|
|
|
if array_type
|
|
"#{array_type} => Array"
|
|
else
|
|
type
|
|
end
|
|
end
|
|
|
|
# We are ignoring connections and built in types for now,
|
|
# they should be added when queries are generated.
|
|
def objects
|
|
object_types = graphql_object_types.select do |object_type|
|
|
!object_type[:name]["Connection"] &&
|
|
!object_type[:name]["Edge"] &&
|
|
!object_type[:name]["__"]
|
|
end
|
|
|
|
object_types.each do |type|
|
|
type[:fields] += type[:connections]
|
|
end
|
|
end
|
|
|
|
# We ignore the built-in enum types.
|
|
def enums
|
|
graphql_enum_types.select do |enum_type|
|
|
!enum_type[:name].in?(%w(__DirectiveLocation __TypeKind))
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|