class GraphQL::Schema::List

Represents a list type in the schema. Wraps a {Schema::Member} as a list type. @see {Schema::Member::TypeSystemHelpers#to_list_type}

Public Instance Methods

coerce_input(value, ctx) click to toggle source
# File lib/graphql/schema/list.rb, line 45
def coerce_input(value, ctx)
  if value.nil?
    nil
  else
    coerced = ensure_array(value).map { |item| item.nil? ? item : of_type.coerce_input(item, ctx) }
    ctx.schema.after_any_lazies(coerced, &:itself)
  end
end
coerce_result(value, ctx) click to toggle source
# File lib/graphql/schema/list.rb, line 41
def coerce_result(value, ctx)
  value.map { |i| i.nil? ? nil : of_type.coerce_result(i, ctx) }
end
description() click to toggle source

Also for implementing introspection

# File lib/graphql/schema/list.rb, line 37
def description
  nil
end
graphql_name() click to toggle source

This is for introspection, where it's expected the name will be `null`

# File lib/graphql/schema/list.rb, line 32
def graphql_name
  nil
end
kind() click to toggle source

@return [GraphQL::TypeKinds::LIST]

# File lib/graphql/schema/list.rb, line 18
def kind
  GraphQL::TypeKinds::LIST
end
list?() click to toggle source

@return [true]

# File lib/graphql/schema/list.rb, line 23
def list?
  true
end
to_graphql() click to toggle source
# File lib/graphql/schema/list.rb, line 13
def to_graphql
  @of_type.graphql_definition(silence_deprecation_warning: true).to_list_type
end
to_type_signature() click to toggle source
# File lib/graphql/schema/list.rb, line 27
def to_type_signature
  "[#{@of_type.to_type_signature}]"
end
validate_non_null_input(value, ctx, max_errors: nil) click to toggle source
# File lib/graphql/schema/list.rb, line 54
def validate_non_null_input(value, ctx, max_errors: nil)
  result = GraphQL::Query::InputValidationResult.new
  ensure_array(value).each_with_index do |item, index|
    item_result = of_type.validate_input(item, ctx)
    unless item_result.valid?
      if max_errors
        if max_errors == 0
          add_max_errros_reached_message(result)
          break
        end

        max_errors -= 1
      end

      result.merge_result!(index, item_result)
    end
  end
  result.valid? ? nil : result
end

Private Instance Methods

add_max_errros_reached_message(result) click to toggle source
# File lib/graphql/schema/list.rb, line 85
def add_max_errros_reached_message(result)
  message = "Too many errors processing list variable, max validation error limit reached. Execution aborted"
  item_result = GraphQL::Query::InputValidationResult.from_problem(message)
  result.merge_result!(nil, item_result)
end
ensure_array(value) click to toggle source
# File lib/graphql/schema/list.rb, line 76
def ensure_array(value)
  # `Array({ a: 1 })` makes `[[:a, 1]]`, so do it manually
  if value.is_a?(Array)
    value
  else
    [value]
  end
end