Class: GraphQL::Pagination::Connections
- Inherits:
-
Object
- Object
- GraphQL::Pagination::Connections
- Defined in:
- lib/graphql/pagination/connections.rb
Overview
A schema-level connection wrapper manager.
Attach as a plugin.
Defined Under Namespace
Classes: ImplementationMissingError
Class Method Summary collapse
Instance Method Summary collapse
-
#add(nodes_class, implementation) ⇒ Object
-
#all_wrappers ⇒ Object
-
#delete(nodes_class) ⇒ Object
-
#edge_class_for_field(field) ⇒ Object
private
use an override if there is one.
-
#initialize(schema:) ⇒ Connections
constructor
A new instance of Connections.
-
#wrap(field, parent, items, arguments, context, wrappers: all_wrappers) ⇒ Object
Used by the runtime to wrap values in connection wrappers.
Constructor Details
#initialize(schema:) ⇒ Connections
Returns a new instance of Connections.
42 43 44 45 46 |
# File 'lib/graphql/pagination/connections.rb', line 42 def initialize(schema:) @schema = schema @wrappers = {} add_default end |
Class Method Details
.use(schema_defn) ⇒ Object
31 32 33 34 35 36 37 38 39 40 |
# File 'lib/graphql/pagination/connections.rb', line 31 def self.use(schema_defn) if schema_defn.is_a?(Class) schema_defn.connections = self.new(schema: schema_defn) else # Unwrap a `.define` object schema_defn = schema_defn.target schema_defn.connections = self.new(schema: schema_defn) schema_defn.class.connections = schema_defn.connections end end |
Instance Method Details
#add(nodes_class, implementation) ⇒ Object
48 49 50 |
# File 'lib/graphql/pagination/connections.rb', line 48 def add(nodes_class, implementation) @wrappers[nodes_class] = implementation end |
#all_wrappers ⇒ Object
56 57 58 59 60 61 62 63 64 |
# File 'lib/graphql/pagination/connections.rb', line 56 def all_wrappers all_wrappers = {} @schema.ancestors.reverse_each do |schema_class| if schema_class.respond_to?(:connections) && (c = schema_class.connections) all_wrappers.merge!(c.wrappers) end end all_wrappers end |
#delete(nodes_class) ⇒ Object
52 53 54 |
# File 'lib/graphql/pagination/connections.rb', line 52 def delete(nodes_class) @wrappers.delete(nodes_class) end |
#edge_class_for_field(field) ⇒ 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.
use an override if there is one
95 96 97 98 99 100 101 102 103 |
# File 'lib/graphql/pagination/connections.rb', line 95 def edge_class_for_field(field) conn_type = field.type.unwrap conn_type_edge_type = conn_type.respond_to?(:edge_class) && conn_type.edge_class if conn_type_edge_type && conn_type_edge_type != Relay::Edge conn_type_edge_type else nil end end |
#wrap(field, parent, items, arguments, context, wrappers: all_wrappers) ⇒ Object
Used by the runtime to wrap values in connection wrappers.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/graphql/pagination/connections.rb', line 68 def wrap(field, parent, items, arguments, context, wrappers: all_wrappers) impl = nil items.class.ancestors.each { |cls| impl = wrappers[cls] break if impl } if impl.nil? raise ImplementationMissingError, "Couldn't find a connection wrapper for #{items.class} during #{field.path} (#{items.inspect})" end impl.new( items, context: context, parent: parent, max_page_size: field.max_page_size || context.schema.default_max_page_size, first: arguments[:first], after: arguments[:after], last: arguments[:last], before: arguments[:before], edge_class: edge_class_for_field(field), ) end |