Module: GraphQL::Types::Relay::ConnectionBehaviors::ClassMethods
- Defined in:
- lib/graphql/types/relay/connection_behaviors.rb
Instance Attribute Summary collapse
-
#edge_class ⇒ Class
readonly
-
#edge_type(edge_type_class, edge_class: GraphQL::Pagination::Connection::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil) ⇒ Object
readonly
Configure this connection to return
edges
andnodes
based onedge_type_class
. -
#node_type ⇒ Class
readonly
Instance Method Summary collapse
-
#authorized?(obj, ctx) ⇒ Boolean
-
#default_relay? ⇒ Boolean
-
#edge_nullable(new_value = nil) ⇒ Object
Set the default
edge_nullable
for this class and its child classes. -
#edges_nullable(new_value = nil) ⇒ Object
Set the default
edges_nullable
for this class and its child classes. -
#has_nodes_field(new_value = nil) ⇒ Object
Set the default
nodes_field
for this class and its child classes. -
#inherited(child_class) ⇒ Object
-
#node_nullable(new_value = nil) ⇒ Object
Set the default
node_nullable
for this class and its child classes. -
#nodes_field(node_nullable: self.node_nullable, field_options: nil) ⇒ Object
Add the shortcut
nodes
field to this connection and its subclasses. -
#scope_items(items, context) ⇒ Object
Filter this list according to the way its node type would scope them.
-
#visible?(ctx) ⇒ Boolean
Instance Attribute Details
#edge_class ⇒ Class
44 45 46 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 44 def edge_class @edge_class end |
#edge_type(edge_type_class, edge_class: GraphQL::Pagination::Connection::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil) ⇒ Object
Configure this connection to return edges
and nodes
based on edge_type_class
.
This method will use the inputs to create:
- edges
field
- nodes
field
- description
It’s called when you subclass this base connection, trying to use the class name to set defaults. You can call it again in the class definition to override the default (or provide a value, if the default lookup failed).
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 57 def edge_type(edge_type_class, edge_class: GraphQL::Pagination::Connection::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil) # Set this connection's graphql name node_type_name = node_type.graphql_name @node_type = node_type @edge_type = edge_type_class @edge_class = edge_class = { name: :edges, type: [edge_type_class, null: edge_nullable], null: edges_nullable, description: "A list of edges.", scope: false, # Assume that the connection was already scoped. connection: false, } if .merge!() end field(**) define_nodes_field(node_nullable, field_options: ) if nodes_field description("The connection type for #{node_type_name}.") end |
#node_type ⇒ Class
41 42 43 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 41 def node_type @node_type end |
Instance Method Details
#authorized?(obj, ctx) ⇒ Boolean
95 96 97 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 95 def (obj, ctx) true # Let nodes be filtered out end |
#default_relay? ⇒ Boolean
36 37 38 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 36 def default_relay? true end |
#edge_nullable(new_value = nil) ⇒ Object
Set the default edge_nullable
for this class and its child classes. (Defaults to true
.)
Use edge_nullable(false)
in your base class to make non-null edge
fields.
126 127 128 129 130 131 132 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 126 def edge_nullable(new_value = nil) if new_value.nil? defined?(@edge_nullable) ? @edge_nullable : superclass.edge_nullable else @edge_nullable = new_value end end |
#edges_nullable(new_value = nil) ⇒ Object
Set the default edges_nullable
for this class and its child classes. (Defaults to true
.)
Use edges_nullable(false)
in your base class to make non-null edges
fields.
116 117 118 119 120 121 122 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 116 def edges_nullable(new_value = nil) if new_value.nil? defined?(@edges_nullable) ? @edges_nullable : superclass.edges_nullable else @edges_nullable = new_value end end |
#has_nodes_field(new_value = nil) ⇒ Object
Set the default nodes_field
for this class and its child classes. (Defaults to true
.)
Use nodes_field(false)
in your base class to prevent adding of a nodes field.
136 137 138 139 140 141 142 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 136 def has_nodes_field(new_value = nil) if new_value.nil? defined?(@nodes_field) ? @nodes_field : superclass.has_nodes_field else @nodes_field = new_value end end |
#inherited(child_class) ⇒ Object
25 26 27 28 29 30 31 32 33 34 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 25 def inherited(child_class) super child_class.has_nodes_field(has_nodes_field) child_class.node_nullable(node_nullable) child_class.edges_nullable(edges_nullable) child_class.edge_nullable(edge_nullable) child_class.edge_type = nil child_class.node_type = nil child_class.edge_class = nil end |
#node_nullable(new_value = nil) ⇒ Object
Set the default node_nullable
for this class and its child classes. (Defaults to true
.)
Use node_nullable(false)
in your base class to make non-null node
and nodes
fields.
106 107 108 109 110 111 112 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 106 def node_nullable(new_value = nil) if new_value.nil? defined?(@node_nullable) ? @node_nullable : superclass.node_nullable else @node_nullable = new_value end end |
#nodes_field(node_nullable: self.node_nullable, field_options: nil) ⇒ Object
Add the shortcut nodes
field to this connection and its subclasses
91 92 93 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 91 def nodes_field(node_nullable: self.node_nullable, field_options: nil) define_nodes_field(node_nullable, field_options: ) end |
#scope_items(items, context) ⇒ Object
Filter this list according to the way its node type would scope them
86 87 88 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 86 def scope_items(items, context) node_type.scope_items(items, context) end |
#visible?(ctx) ⇒ Boolean
99 100 101 102 |
# File 'lib/graphql/types/relay/connection_behaviors.rb', line 99 def visible?(ctx) # if this is an abstract base class, there may be no `node_type` node_type ? node_type.visible?(ctx) : super end |