class GraphQL::EnumType

@api deprecated

Attributes

ast_node[RW]

Public Class Methods

new() click to toggle source
Calls superclass method GraphQL::BaseType::new
# File lib/graphql/enum_type.rb, line 11
def initialize
  super
  @values_by_name = {}
end

Public Instance Methods

add_value(enum_value) click to toggle source

@param enum_value [EnumValue] A value to add to this type's set of values

# File lib/graphql/enum_type.rb, line 28
def add_value(enum_value)
  if @values_by_name.key?(enum_value.name)
    raise "Enum value names must be unique. Value `#{enum_value.name}` already exists on Enum `#{name}`."
  end

  @values_by_name[enum_value.name] = enum_value
end
coerce_result(value, ctx = nil) click to toggle source
# File lib/graphql/enum_type.rb, line 49
def coerce_result(value, ctx = nil)
  if ctx.nil?
    warn_deprecated_coerce("coerce_isolated_result")
    ctx = GraphQL::Query::NullContext
  end

  warden = ctx.warden
  all_values = warden ? warden.enum_values(self) : @values_by_name.each_value
  enum_value = all_values.find { |val| val.value == value }
  if enum_value
    enum_value.name
  else
    raise(UnresolvedValueError, "Can't resolve enum #{name} for #{value.inspect}")
  end
end
enum_values(_context = nil) click to toggle source
# File lib/graphql/enum_type.rb, line 41
def enum_values(_context = nil)
  values.values
end
initialize_copy(other) click to toggle source
Calls superclass method GraphQL::BaseType#initialize_copy
# File lib/graphql/enum_type.rb, line 16
def initialize_copy(other)
  super
  self.values = other.values.values
end
kind() click to toggle source
# File lib/graphql/enum_type.rb, line 45
def kind
  GraphQL::TypeKinds::ENUM
end
to_s() click to toggle source
# File lib/graphql/enum_type.rb, line 65
def to_s
  name
end
values(_context = nil) click to toggle source

@return [Hash<String => EnumValue>] `{name => value}` pairs contained in this type

# File lib/graphql/enum_type.rb, line 37
def values(_context = nil)
  @values_by_name
end
values=(new_values) click to toggle source

@param new_values [Array<EnumValue>] The set of values contained in this type

# File lib/graphql/enum_type.rb, line 22
def values=(new_values)
  @values_by_name = {}
  new_values.each { |enum_value| add_value(enum_value) }
end

Private Instance Methods

coerce_non_null_input(value_name, ctx) click to toggle source

Get the underlying value for this enum value

@example get episode value from Enum

episode = EpisodeEnum.coerce("NEWHOPE")
episode # => 6

@param value_name [String] the string representation of this enum value @return [Object] the underlying value for this enum value

# File lib/graphql/enum_type.rb, line 109
def coerce_non_null_input(value_name, ctx)
  if @values_by_name.key?(value_name)
    @values_by_name.fetch(value_name).value
  elsif match_by_value = @values_by_name.find { |k, v| v.value == value_name }
    # this is for matching default values, which are "inputs", but they're
    # the Ruby value, not the GraphQL string.
    match_by_value[1].value
  else
    nil
  end
end
validate_non_null_input(value_name, ctx) click to toggle source
# File lib/graphql/enum_type.rb, line 121
def validate_non_null_input(value_name, ctx)
  result = GraphQL::Query::InputValidationResult.new
  allowed_values = ctx.warden.enum_values(self)
  matching_value = allowed_values.find { |v| v.name == value_name }

  if matching_value.nil?
    result.add_problem("Expected #{GraphQL::Language.serialize(value_name)} to be one of: #{allowed_values.map(&:name).join(', ')}")
  end

  result
end