Class: GraphQL::Schema::Union

Inherits:
Member
  • Object
show all
Extended by:
Member::AcceptsDefinition, Member::HasUnresolvedTypeError
Defined in:
lib/graphql/schema/union.rb

Constant Summary

Constants included from Member::HasDirectives

Member::HasDirectives::NO_DIRECTIVES

Constants included from Member::GraphQLTypeNames

Member::GraphQLTypeNames::Boolean, Member::GraphQLTypeNames::ID, Member::GraphQLTypeNames::Int

Class Method Summary collapse

Methods included from Member::CachedGraphQLDefinition

#graphql_definition, #initialize_copy, #type_class

Methods included from Relay::TypeExtensions

#connection_type, #define_connection, #define_edge, #edge_type

Methods included from Member::BaseDSLMethods

#accessible?, #authorized?, #default_graphql_name, #description, #graphql_name, #introspection, #introspection?, #mutation, #name, #overridden_graphql_name, #to_graphql, #visible?

Methods included from Member::BaseDSLMethods::ConfigurationExtension

#inherited

Methods included from Member::TypeSystemHelpers

#kind, #list?, #non_null?, #to_list_type, #to_non_null_type, #to_type_signature

Methods included from Member::Scoped

#scope_items

Methods included from Member::RelayShortcuts

#connection_type, #connection_type_class, #edge_type, #edge_type_class

Methods included from Member::HasPath

#path

Methods included from Member::HasAstNode

#ast_node

Methods included from Member::HasDirectives

#directive, #directives, #remove_directive

Class Method Details

.assign_type_membership_object_type(object_type) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Update a type membership whose .object_type is a string or late-bound type so that the type membership’s .object_type is the given object_type. (This is used for updating the union after the schema as lazily loaded the union member.)



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/graphql/schema/union.rb', line 64

def assign_type_membership_object_type(object_type)
  assert_valid_union_member(object_type)
  type_memberships.each { |tm|
    possible_type = tm.object_type
    if possible_type.is_a?(String) && (possible_type == object_type.name)
      # This is a match of Ruby class names, not graphql names,
      # since strings are used to refer to constants.
      tm.object_type = object_type
    elsif possible_type.is_a?(LateBoundType) && possible_type.graphql_name == object_type.graphql_name
      tm.object_type = object_type
    end
  }
  nil
end

.kind ⇒ Object 



52
53
54
 
# File 'lib/graphql/schema/union.rb', line 52

def kind
  GraphQL::TypeKinds::UNION
end

.possible_types(*types, context: GraphQL::Query::NullContext, **options) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/graphql/schema/union.rb', line 14

def possible_types(*types, context: GraphQL::Query::NullContext, **options)
  if types.any?
    types.each do |t|
      assert_valid_union_member(t)
      type_memberships << type_membership_class.new(self, t, **options)
    end
  else
    visible_types = []
    type_memberships.each do |type_membership|
      if type_membership.visible?(context)
        visible_types << type_membership.object_type
      end
    end
    visible_types
  end
end

.to_graphql ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/graphql/schema/union.rb', line 31

def to_graphql
  type_defn = GraphQL::UnionType.new
  type_defn.name = graphql_name
  type_defn.description = description
  type_defn.ast_node = ast_node
  type_defn.type_memberships = type_memberships
  if respond_to?(:resolve_type)
    type_defn.resolve_type = method(:resolve_type)
  end
  type_defn.metadata[:type_class] = self
  type_defn
end

.type_membership_class(membership_class = nil) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/graphql/schema/union.rb', line 44

def type_membership_class(membership_class = nil)
  if membership_class
    @type_membership_class = membership_class
  else
    @type_membership_class || find_inherited_value(:type_membership_class, GraphQL::Schema::TypeMembership)
  end
end

.type_memberships ⇒ Object 



56
57
58
 
# File 'lib/graphql/schema/union.rb', line 56

def type_memberships
  @type_memberships ||= []
end