class GraphQL::Language::DocumentFromSchemaDefinition

@api private

{GraphQL::Language::DocumentFromSchemaDefinition} is used to convert a {GraphQL::Schema} object To a {GraphQL::Language::Document} AST node.

@param context [Hash] @param only [<#call(member, ctx)>] @param except [<#call(member, ctx)>] @param #include_introspection_types [Boolean] Whether or not to include introspection types in the AST @param #include_built_in_scalars [Boolean] Whether or not to include built in scalars in the AST @param #include_built_in_directives [Boolean] Whether or not to include built in diirectives in the AST

Attributes

always_include_schema[R]
include_built_in_directives[R]
include_built_in_scalars[R]
include_introspection_types[R]
schema[R]
warden[R]

Public Class Methods

new( schema, context: nil, only: nil, except: nil, include_introspection_types: false, include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false ) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 15
def initialize(
  schema, context: nil, only: nil, except: nil, include_introspection_types: false,
  include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false
)
  @schema = schema
  @always_include_schema = always_include_schema
  @include_introspection_types = include_introspection_types
  @include_built_in_scalars = include_built_in_scalars
  @include_built_in_directives = include_built_in_directives

  @warden = GraphQL::Schema::Warden.new(
    GraphQL::Filter.new(only: only, except: except),
    schema: @schema,
    context: context,
  )
end

Public Instance Methods

build_argument_node(argument) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 125
def build_argument_node(argument)
  argument_node = GraphQL::Language::Nodes::InputValueDefinition.new(
    name: argument.name,
    description: argument.description,
    type: build_type_name_node(argument.type),
  )

  if argument.default_value?
    argument_node.default_value = build_default_value(argument.default_value, argument.type)
  end

  argument_node
end
build_argument_nodes(arguments) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 229
def build_argument_nodes(arguments)
  arguments
    .map { |arg| build_argument_node(arg) }
    .sort_by(&:name)
end
build_default_value(default_value, type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 181
def build_default_value(default_value, type)
  if default_value.nil?
    return GraphQL::Language::Nodes::NullValue.new(name: "null")
  end

  case type
  when GraphQL::ScalarType
    type.coerce_isolated_result(default_value)
  when EnumType
    GraphQL::Language::Nodes::Enum.new(name: type.coerce_isolated_result(default_value))
  when InputObjectType
    GraphQL::Language::Nodes::InputObject.new(
      arguments: default_value.to_h.map do |arg_name, arg_value|
        arg_type = type.input_fields.fetch(arg_name.to_s).type
        GraphQL::Language::Nodes::Argument.new(
          name: arg_name,
          value: build_default_value(arg_value, arg_type)
        )
      end
    )
  when NonNullType
    build_default_value(default_value, type.of_type)
  when ListType
    default_value.to_a.map { |v| build_default_value(v, type.of_type) }
  else
    raise NotImplementedError, "Unexpected default value type #{type.inspect}"
  end
end
build_definition_nodes() click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 245
def build_definition_nodes
  definitions = []
  definitions << build_schema_node if include_schema_node?
  definitions += build_directive_nodes(warden.directives)
  definitions += build_type_definition_nodes(warden.types)
  definitions
end
build_directive_location_node(location) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 160
def build_directive_location_node(location)
  GraphQL::Language::Nodes::DirectiveLocation.new(
    name: location.to_s
  )
end
build_directive_location_nodes(locations) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 156
def build_directive_location_nodes(locations)
  locations.map { |location| build_directive_location_node(location) }
end
build_directive_node(directive) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 147
def build_directive_node(directive)
  GraphQL::Language::Nodes::DirectiveDefinition.new(
    name: directive.name,
    arguments: build_argument_nodes(warden.arguments(directive)),
    locations: build_directive_location_nodes(directive.locations),
    description: directive.description,
  )
end
build_directive_nodes(directives) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 235
def build_directive_nodes(directives)
  if !include_built_in_directives
    directives = directives.reject { |directive| directive.default_directive? }
  end

  directives
    .map { |directive| build_directive_node(directive) }
    .sort_by(&:name)
end
build_enum_type_node(enum_type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 92
def build_enum_type_node(enum_type)
  GraphQL::Language::Nodes::EnumTypeDefinition.new(
    name: enum_type.name,
    values: warden.enum_values(enum_type).sort_by(&:name).map do |enum_value|
      build_enum_value_node(enum_value)
    end,
    description: enum_type.description,
  )
end
build_enum_value_node(enum_value) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 102
def build_enum_value_node(enum_value)
  enum_value_node = GraphQL::Language::Nodes::EnumValueDefinition.new(
    name: enum_value.name,
    description: enum_value.description,
  )

  if enum_value.deprecation_reason
    enum_value_node.directives << GraphQL::Language::Nodes::Directive.new(
      name: GraphQL::Directive::DeprecatedDirective.name,
      arguments: [GraphQL::Language::Nodes::Argument.new(name: "reason", value: enum_value.deprecation_reason)]
    )
  end

  enum_value_node
end
build_field_node(field) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 58
def build_field_node(field)
  field_node = GraphQL::Language::Nodes::FieldDefinition.new(
    name: field.name,
    arguments: build_argument_nodes(warden.arguments(field)),
    type: build_type_name_node(field.type),
    description: field.description,
  )

  if field.deprecation_reason
    field_node.directives << GraphQL::Language::Nodes::Directive.new(
      name: GraphQL::Directive::DeprecatedDirective.name,
      arguments: [GraphQL::Language::Nodes::Argument.new(name: "reason", value: field.deprecation_reason)]
    )
  end

  field_node
end
build_field_nodes(fields) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 267
def build_field_nodes(fields)
  fields
    .map { |field| build_field_node(field) }
    .sort_by(&:name)
end
build_input_object_node(input_object) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 139
def build_input_object_node(input_object)
  GraphQL::Language::Nodes::InputObjectTypeDefinition.new(
    name: input_object.name,
    fields: build_argument_nodes(warden.arguments(input_object)),
    description: input_object.description,
  )
end
build_interface_type_node(interface_type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 84
def build_interface_type_node(interface_type)
  GraphQL::Language::Nodes::InterfaceTypeDefinition.new(
    name: interface_type.name,
    description: interface_type.description,
    fields: build_field_nodes(warden.fields(interface_type))
  )
end
build_object_type_node(object_type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 49
def build_object_type_node(object_type)
  GraphQL::Language::Nodes::ObjectTypeDefinition.new(
    name: object_type.name,
    interfaces: warden.interfaces(object_type).sort_by(&:name).map { |iface| build_type_name_node(iface) },
    fields: build_field_nodes(warden.fields(object_type)),
    description: object_type.description,
  )
end
build_scalar_type_node(scalar_type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 118
def build_scalar_type_node(scalar_type)
  GraphQL::Language::Nodes::ScalarTypeDefinition.new(
    name: scalar_type.name,
    description: scalar_type.description,
  )
end
build_schema_node() click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 38
def build_schema_node
  GraphQL::Language::Nodes::SchemaDefinition.new(
    query: warden.root_type_for_operation("query"),
    mutation: warden.root_type_for_operation("mutation"),
    subscription: warden.root_type_for_operation("subscription"),
    # This only supports directives from parsing,
    # use a custom printer to add to this list.
    directives: @schema.ast_node ? @schema.ast_node.directives : [],
  )
end
build_type_definition_node(type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 210
def build_type_definition_node(type)
  case type
  when GraphQL::ObjectType
    build_object_type_node(type)
  when GraphQL::UnionType
    build_union_type_node(type)
  when GraphQL::InterfaceType
    build_interface_type_node(type)
  when GraphQL::ScalarType
    build_scalar_type_node(type)
  when GraphQL::EnumType
    build_enum_type_node(type)
  when GraphQL::InputObjectType
    build_input_object_node(type)
  else
    raise TypeError
  end
end
build_type_definition_nodes(types) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 253
def build_type_definition_nodes(types)
  if !include_introspection_types
    types = types.reject { |type| type.introspection? }
  end

  if !include_built_in_scalars
    types = types.reject { |type| type.default_scalar? }
  end

  types
    .map { |type| build_type_definition_node(type) }
    .sort_by(&:name)
end
build_type_name_node(type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 166
def build_type_name_node(type)
  case type
  when GraphQL::ListType
    GraphQL::Language::Nodes::ListType.new(
      of_type: build_type_name_node(type.of_type)
    )
  when GraphQL::NonNullType
    GraphQL::Language::Nodes::NonNullType.new(
      of_type: build_type_name_node(type.of_type)
    )
  else
    GraphQL::Language::Nodes::TypeName.new(name: type.name)
  end
end
build_union_type_node(union_type) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 76
def build_union_type_node(union_type)
  GraphQL::Language::Nodes::UnionTypeDefinition.new(
    name: union_type.name,
    description: union_type.description,
    types: warden.possible_types(union_type).sort_by(&:name).map { |type| build_type_name_node(type) }
  )
end
document() click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 32
def document
  GraphQL::Language::Nodes::Document.new(
    definitions: build_definition_nodes
  )
end

Private Instance Methods

include_schema_node?() click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 275
def include_schema_node?
  always_include_schema || !schema_respects_root_name_conventions?(schema)
end
schema_respects_root_name_conventions?(schema) click to toggle source
# File lib/graphql/language/document_from_schema_definition.rb, line 279
def schema_respects_root_name_conventions?(schema)
  (schema.query.nil? || schema.query.name == 'Query') &&
  (schema.mutation.nil? || schema.mutation.name == 'Mutation') &&
  (schema.subscription.nil? || schema.subscription.name == 'Subscription')
end